nylas
    Preparing search index...

    Interface Calendar

    Interface of a Nylas calendar object

    interface Calendar {
        description?: string;
        grantId: string;
        hexColor?: string;
        hexForegroundColor?: string;
        id: string;
        isOwnedByUser: boolean;
        isPrimary?: boolean;
        location?: string;
        metadata?: Record<string, unknown>;
        name: string;
        notetaker?: CalendarNotetaker;
        object: string;
        readOnly: boolean;
        timezone: string;
    }
    Index

    Properties

    description? grantId hexColor? hexForegroundColor? id isOwnedByUser isPrimary? location? metadata? name notetaker? object readOnly timezone

    Properties

    description?: string

    Description of the calendar.

    grantId: string

    Grant ID of the Nylas account.

    hexColor?: string

    The background color of the calendar in the hexadecimal format (e.g. #0099EE). Empty indicates default color.

    hexForegroundColor?: string

    The background color of the calendar in the hexadecimal format (e.g. #0099EE). Empty indicates default color. (Google only)

    id: string

    Globally unique object identifier.

    isOwnedByUser: boolean

    If the calendar is owned by the user account.

    isPrimary?: boolean

    If the calendar is the primary calendar.

    location?: string

    Geographic location of the calendar as free-form text.

    metadata?: Record<string, unknown>

    A list of key-value pairs storing additional data.

    name: string

    Name of the Calendar.

    notetaker?: CalendarNotetaker

    Notetaker meeting bot settings

    object: string

    The type of object.

    readOnly: boolean

    If the event participants are able to edit the event.

    timezone: string

    IANA time zone database formatted string (e.g. America/New_York).

    List of tz database time zones

    Settings

    Member Visibility

    On This Page

    Properties