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

    Interface CreateReminderOptions

    7.1.0

    interface CreateReminderOptions {
        alerts?: number[];
        commit?: boolean;
        completionDate?: number;
        dueDate?: number;
        isCompleted?: boolean;
        listId?: string;
        location?: string;
        notes?: string;
        priority?: number;
        recurrence?: RecurrenceRule;
        startDate?: number;
        title: string;
        url?: string;
    }
    Index

    Properties

    alerts? commit? completionDate? dueDate? isCompleted? listId? location? notes? priority? recurrence? startDate? title url?

    Properties

    alerts?: number[]

    Alert times in minutes relative to the reminder start. Use negative numbers for alerts before the start, and positive numbers for alerts after the start.

    On iOS only 2 alerts are supported.

    // -1440 -> 1 day before
    // -60 -> 1 hour before
    // 30 -> 30 minutes after
    [-1440, -60, 30]

    7.1.0

    commit?: boolean

    Whether to save immediately (true) or batch changes for later (false). Pass false to batch multiple changes and commit them together using CapacitorCalendar.commit(), which is more efficient than committing each save individually.

    true

    iOS

    CalendarOperations#commit

    8.7.0

    completionDate?: number

    7.1.0

    dueDate?: number

    When the reminder should be completed, in milliseconds since the epoch. On iOS, if startDate is omitted, it is set to this value.

    7.1.0

    isCompleted?: boolean

    7.1.0

    listId?: string

    7.1.0

    location?: string

    7.1.0

    notes?: string

    7.1.0

    priority?: number

    Priority: 0 none, 1 highest through 9 lowest.

    7.1.0

    recurrence?: RecurrenceRule

    iOS

    7.1.0

    startDate?: number

    When the reminder starts, in milliseconds since the epoch. Relative alerts use this date.

    7.1.0

    title: string

    7.1.0

    url?: string

    7.1.0

    Settings

    Member Visibility

    On This Page

    Properties