@ebarooni/capacitor-calendar
Version:
A capacitor plugin for managing calendar events on iOS and Android, with reminders support on iOS.
82 lines (81 loc) • 1.74 kB
TypeScript
import type { EventAvailability } from '../enums/event-availability';
import type { EventRecurrenceRule } from './event-recurrence-rule';
/**
* @since 7.1.0
*/
export interface CreateEventWithPromptOptions {
/**
* Alert times in minutes relative to the event start.
* Use negative numbers for reminders before the start, and positive numbers for reminders after the start.
* On iOS only 2 alerts are supported.
*
* @example
* // -1440 -> 1 day before
* // -60 -> 1 hour before
* // 30 -> 30 minutes after
* [-1440, -60, 30]
*
* @platform iOS
* @since 7.1.0
*/
alerts?: number[];
/**
* @platform Android, iOS
* @since 7.1.0
*/
availability?: EventAvailability;
/**
* @platform iOS
* @since 0.1.0
*/
calendarId?: string;
/**
* @platform Android, iOS
* @since 7.1.0
*/
description?: string;
/**
* @platform Android, iOS
* @since 0.1.0
*/
endDate?: number;
/**
* An array of emails to invite.
*
* @platform Android
* @since 7.1.0
*/
invitees?: string[];
/**
* @platform Android, iOS
* @since 0.1.0
*/
isAllDay?: boolean;
/**
* @platform Android, iOS
* @since 0.1.0
*/
location?: string;
/**
* Rules for creating a recurring event.
*
* @platform Android, iOS
* @since 7.3.0
*/
recurrence?: EventRecurrenceRule;
/**
* @platform Android, iOS
* @since 0.1.0
*/
startDate?: number;
/**
* @platform Android, iOS
* @since 0.1.0
*/
title?: string;
/**
* @platform iOS
* @since 0.1.0
*/
url?: string;
}