Interface Calendar

Interface of a Nylas calendar object

Hierarchy

  • Calendar

Properties

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

Properties

Optional description

description?: string

Description of the calendar.

grantId

grantId: string

Grant ID of the Nylas account.

Optional hexColor

hexColor?: string

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

Optional hexForegroundColor

hexForegroundColor?: string

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

id

id: string

Globally unique object identifier.

isOwnedByUser

isOwnedByUser: boolean

If the calendar is owned by the user account.

Optional isPrimary

isPrimary?: boolean

If the calendar is the primary calendar.

Optional location

location?: string

Geographic location of the calendar as free-form text.

Optional metadata

metadata?: Record<string, unknown>

A list of key-value pairs storing additional data.

name

name: string

Name of the Calendar.

object

object: string

The type of object.

readOnly

readOnly: boolean

If the event participants are able to edit the event.

timezone

timezone: string

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

See

List of tz database time zones

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc