@ebarooni/capacitor-calendar
Version:
A capacitor plugin for managing calendar events on iOS and Android, with reminders support on iOS.
64 lines (63 loc) • 1.16 kB
TypeScript
import type { RecurrenceRule } from './recurrence-rule';
/**
* @since 7.1.0
*/
export interface CreateReminderOptions {
/**
* @since 7.1.0
*/
title: string;
/**
* @since 7.1.0
*/
listId?: string;
/**
* @since 7.1.0
*/
priority?: number;
/**
* @since 7.1.0
*/
isCompleted?: boolean;
/**
* @since 7.1.0
*/
startDate?: number;
/**
* @since 7.1.0
*/
dueDate?: number;
/**
* @since 7.1.0
*/
completionDate?: number;
/**
* @since 7.1.0
*/
notes?: string;
/**
* @since 7.1.0
*/
url?: string;
/**
* @since 7.1.0
*/
location?: string;
/**
* @since 7.1.0
*/
recurrence?: RecurrenceRule;
/**
* 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.
*
* @example
* // -1440 -> 1 day before
* // -60 -> 1 hour before
* // 30 -> 30 minutes after
* [-1440, -60, 30]
*
* @since 7.1.0
*/
alerts?: number[];
}