nylas
    Preparing search index...

    Interface Event

    Interface representing a Nylas Event object.

    interface Event {
        busy: boolean;
        calendarId: string;
        conferencing?: Conferencing;
        createdAt?: number;
        creator?: EmailName;
        description?: string;
        grantId: string;
        hideParticipants?: boolean;
        htmlLink?: string;
        icalUid?: string;
        id: string;
        location?: string;
        masterEventId?: string;
        metadata?: Record<string, string>;
        notetaker?: NotetakerSettings;
        object: "event";
        organizer?: EmailName;
        participants: Participant[];
        readOnly: boolean;
        recurrence?: string[];
        reminders?: Reminders;
        status?: Status;
        title?: string;
        updatedAt?: number;
        visibility: Visibility;
        when: When;
    }
    Index

    Properties

    busy calendarId conferencing? createdAt? creator? description? grantId hideParticipants? htmlLink? icalUid? id location? masterEventId? metadata? notetaker? object organizer? participants readOnly recurrence? reminders? status? title? updatedAt? visibility when

    Properties

    busy: boolean

    This value determines whether to show this event's time block as available on shared or public calendars.

    calendarId: string

    Calendar ID of the event.

    conferencing?: Conferencing

    Representation of conferencing details for events. Conferencing object can be in one of two formats (sub-objects):

    createdAt?: number

    Unix timestamp when the event was created.

    creator?: EmailName

    User who created the event. Not supported for all providers.

    description?: string

    Description of the event.

    grantId: string

    Grant ID of the Nylas account.

    hideParticipants?: boolean

    Whether participants of the event should be hidden.

    htmlLink?: string

    A link to this event in the provider's UI

    icalUid?: string

    Unique id for iCalendar standard, for identifying events across calendaring systems. Recurring events may share the same value. Can be null for events synced before the year 2020.

    id: string

    Globally unique object identifier.

    location?: string

    Location of the event, such as a physical address or meeting room name.

    masterEventId?: string

    Master event id if recurring events.

    metadata?: Record<string, string>

    List of key-value pairs storing additional data.

    notetaker?: NotetakerSettings

    Notetaker meeting bot settings

    object: "event"

    The type of object.

    organizer?: EmailName

    Organizer of the event.

    participants: Participant[]

    List of participants invited to the event. Participants may also be rooms or resources.

    readOnly: boolean

    If the event participants are able to edit the event.

    recurrence?: string[]

    An list of RRULE and EXDATE strings.

    RFC-5545

    reminders?: Reminders

    A list of reminders to send for the event. If left empty or omitted, the event uses the provider defaults.

    status?: Status

    Status of the event.

    title?: string

    Title of the event.

    updatedAt?: number

    Unix timestamp when the event was last updated.

    visibility: Visibility

    Visibility of the event, if the event is private or public.

    when: When

    Representation of time and duration for events. When object can be in one of four formats (sub-objects):

    Settings

    Member Visibility

    On This Page

    Properties