Interface Event

Interface representing a Nylas Event object.

Hierarchy

  • Event

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.

metadata?: Record<string, string>

List of key-value pairs storing additional data.

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.

reminders?: Reminder[]

List of reminders for the event.

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):

Generated using TypeDoc