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

    Interface ModifyReminderOptions

    7.1.0

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

    Properties

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

    Properties

    alerts?: number[] | null

    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. Omit or pass undefined to leave existing alerts unchanged. Pass null or an empty array [] to clear alerts. On iOS, when both startDate and dueDate are cleared in the same call, alerts are cleared even if alerts is set. When clearing dates across separate batched calls, pass alerts: null or [] explicitly.

    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 | null

    When the reminder was completed, in milliseconds since the epoch. Omit or pass undefined to leave the existing value unchanged. Since 8.7.0, pass null to clear. Clearing this date does not mark the reminder incomplete; set isCompleted to false for that.

    7.1.0

    dueDate?: number | null

    When the reminder is due, in milliseconds since the epoch. On iOS, if startDate is omitted and the reminder has no start, it is set to this value. Omit or pass undefined to leave the existing value unchanged. Since 8.7.0, pass null to clear. Clearing only dueDate leaves an existing start unchanged (including a start previously copied from due). Pass startDate: null together with dueDate: null to remove scheduling.

    7.1.0

    id: string

    7.1.0

    isCompleted?: boolean

    7.1.0

    listId?: string

    7.1.0

    location?: string | null

    Location for the reminder. Omit or pass undefined to leave the existing value unchanged. Since 8.7.0, pass null to clear.

    7.1.0

    notes?: string | null

    Notes for the reminder. Omit or pass undefined to leave the existing value unchanged. Since 8.7.0, pass null to clear.

    7.1.0

    priority?: number

    Priority: 0 none, 1 highest through 9 lowest. Omit to leave the existing value unchanged.

    7.1.0

    recurrence?: RecurrenceRule | null

    Recurrence rule for the reminder. Omit or pass undefined to leave the existing value unchanged. Since 8.7.0, pass null to clear.

    iOS

    7.1.0

    startDate?: number | null

    When the reminder starts, in milliseconds since the epoch. Relative alerts use this date. Omit or pass undefined to leave the existing value unchanged. Since 8.7.0, pass null to clear. If a due date remains, clearing start sets start to the due date (it does not keep the previous start). Pass dueDate: null as well to remove scheduling.

    7.1.0

    title?: string

    7.1.0

    url?: string | null

    URL associated with the reminder. Omit or pass undefined to leave the existing value unchanged. Since 8.7.0, pass null to clear.

    7.1.0

    Settings

    Member Visibility

    On This Page

    Properties