Interface CreateEventOptions

Since

7.1.0

interface CreateEventOptions {
    alerts?: number[];
    attendees?: EventGuest[];
    availability?: EventAvailability;
    calendarId?: string;
    color?: string;
    commit?: boolean;
    description?: string;
    duration?: string;
    endDate?: number;
    isAllDay?: boolean;
    location?: string;
    organizer?: string;
    startDate?: number;
    title: string;
    url?: string;
}

Properties

alerts? attendees? availability? calendarId? color? commit? description? duration? endDate? isAllDay? location? organizer? startDate? title url?

Properties

Optionalalerts

alerts?: number[]

Platform

Android, iOS

Since

7.1.0

Optionalattendees

attendees?: EventGuest[]

The event guests.

Platform

Android

Since

7.1.0

Optionalavailability

availability?: EventAvailability

Platform

Android, iOS

Since

7.1.0

OptionalcalendarId

calendarId?: string

Platform

Android, iOS

Since

0.1.0

Optionalcolor

color?: string

Example

#6750A4

Platform

Android

Since

7.1.0

Optionalcommit

commit?: boolean

Whether to save immediately (true) or batch changes for later (false).

Default

true

Platform

iOS

See

CalendarOperations#commit

Since

7.1.0

Optionaldescription

description?: string

Platform

Android, iOS

Since

7.1.0

Optionalduration

duration?: string

Duration of the event in RFC2445 format.

Example

P1D (1 day), P3W (3 weeks), P2DT4H30M (2 days, 4 hours, and 30 minutes).

Platform

Android

See

https://datatracker.ietf.org/doc/html/rfc2445

Since

7.1.0

OptionalendDate

endDate?: number

Platform

Android, iOS

Since

0.1.0

OptionalisAllDay

isAllDay?: boolean

Platform

Android, iOS

Since

0.1.0

Optionallocation

location?: string

Platform

Android, iOS

Since

0.1.0

Optionalorganizer

organizer?: string

Email of the event organizer.

Platform

Android

Since

7.1.0

OptionalstartDate

startDate?: number

Platform

Android, iOS

Since

0.1.0

title

title: string

Platform

Android, iOS

Since

0.4.0

Optionalurl

url?: string

Platform

iOS

Since

0.1.0

Settings

Member Visibility

On This Page

Properties