@ebarooni/capacitor-calendar
    Preparing search index...

    Interface CalendarEvent

    7.1.0

    interface CalendarEvent {
        alerts: number[];
        attendees: {
            email: string | null;
            name: string | null;
            role: AttendeeRole | null;
            status: AttendeeStatus | null;
            type: AttendeeType | null;
        }[];
        availability: EventAvailability
        | null;
        birthdayContactIdentifier: string | null;
        calendarId: string | null;
        calendarItemExternalIdentifier: string | null;
        color: string | null;
        creationDate: number | null;
        description: string | null;
        duration: string | null;
        endDate: number;
        id: string;
        isAllDay: boolean;
        isDetached: boolean | null;
        isPartOfSeries: boolean;
        lastModifiedDate: number | null;
        location: string | null;
        masterId: string | null;
        organizer: string | null;
        seriesStartDate: number;
        startDate: number;
        status: EventStatus | null;
        timezone: string | null;
        title: string;
        url: string | null;
    }
    Index

    Properties

    alerts: number[]

    Alert times in minutes relative to the event start.

    Android, iOS

    7.1.0

    attendees: {
        email: string | null;
        name: string | null;
        role: AttendeeRole | null;
        status: AttendeeStatus | null;
        type: AttendeeType | null;
    }[]

    Type Declaration

    • email: string | null

      Android

      7.1.0

    • name: string | null

      Android, iOS

      7.1.0

    • role: AttendeeRole | null

      Equivalent to ATTENDEE_RELATIONSHIP on Android. Equivalent to EKParticipantRole on iOS.

      Android, iOS

      7.1.0

    • status: AttendeeStatus | null

      Equivalent to ATTENDEE_STATUS on Android. Equivalent to EKParticipantStatus on iOS.

      Android, iOS

      7.1.0

    • type: AttendeeType | null

      Equivalent to ATTENDEE_TYPE on Android. Equivalent to EKParticipantType on iOS.

      Android, iOS

      7.1.0

    Android, iOS

    7.1.0

    availability: EventAvailability | null

    Android, iOS

    7.1.0

    birthdayContactIdentifier: string | null
    calendarId: string | null

    Android, iOS

    7.1.0

    calendarItemExternalIdentifier: string | null

    A stable external id for this calendar item.

    On iOS this is set when the system provides it. On Android and web it is always null. Use masterId on Android for the series master id.

    Do not treat this field as the same as masterId. They identify different things on different platforms.

    For non-detached occurrences of a series, this value is shared across those occurrences. On one device, id is often already shared for them. This field is mainly useful as a stable id across devices.

    Detached exceptions usually get a new identifier. You cannot find the original series from this value. Use isDetached and isPartOfSeries instead. Do not pass this value where the plugin expects an event id.

    color: string | null

    Android, iOS

    7.1.0

    creationDate: number | null

    iOS

    7.1.0

    description: string | null

    Android, iOS

    7.1.0

    duration: string | null

    Android

    7.1.0

    endDate: number

    Android, iOS

    7.1.0

    id: string

    Android, iOS

    7.1.0

    isAllDay: boolean

    Android, iOS

    7.1.0

    isDetached: boolean | null

    iOS

    7.1.0

    isPartOfSeries: boolean

    Whether this event belongs to a recurring series.

    true for series occurrences and detached exceptions. false for one-off events.

    Detached exceptions also set isDetached (iOS only).

    true
    

    Android, iOS

    8.6.0

    lastModifiedDate: number | null

    iOS

    7.1.0

    location: string | null

    Android, iOS

    7.1.0

    masterId: string | null

    The id of the series master for this listed occurrence.

    On Android this is always a string. On iOS and web it is always null. iOS has no public master event id. Use calendarItemExternalIdentifier on iOS instead.

    Do not treat this field as the same as calendarItemExternalIdentifier. They identify different things on different platforms.

    If this row is the master or a one-shot event, masterId equals id. If this row is an exception, id is the exception and masterId is the series master.

    To modify or delete the whole series, pass masterId as the id option. You still need span and instanceDate when those APIs require them.

    In rare sync cases, an exception may temporarily report masterId equal to id until the platform links it to the series master.

    "42"
    

    Android

    8.6.0

    organizer: string | null

    Android, iOS

    7.1.0

    seriesStartDate: number

    Start time of the recurring series, in milliseconds since the epoch.

    Equals startDate for one-off events. On iOS, equals startDate when the series start is not available for a detached exception.

    1719792000000
    

    Android, iOS

    8.6.0

    startDate: number

    Android, iOS

    7.1.0

    status: EventStatus | null

    Android, iOS

    7.1.0

    timezone: string | null

    Android, iOS

    7.1.0

    title: string

    Android, iOS

    7.1.0

    url: string | null

    iOS

    7.1.0