calendar module
Interact with the user's calendar, including opening calendar items and composing meetings.
Interfaces
| ComposeMeetingParams |
Compose meeting parameters |
| OpenCalendarItemParams |
Open calendar item parameters. |
Functions
| compose |
Compose a new meeting in the user's calendar. |
| is |
Checks if the calendar capability is supported by the host |
| open |
Opens a calendar item. |
Function Details
composeMeeting(ComposeMeetingParams)
Compose a new meeting in the user's calendar.
function composeMeeting(composeMeetingParams: ComposeMeetingParams): Promise<void>Parameters
- composeMeetingParams
- ComposeMeetingParams
object containing various properties to set up the meeting details.
Returns
Promise<void>
isSupported()
Checks if the calendar capability is supported by the host
function isSupported(): booleanReturns
boolean
boolean to represent whether the calendar capability is supported
openCalendarItem(OpenCalendarItemParams)
Opens a calendar item.
function openCalendarItem(openCalendarItemParams: OpenCalendarItemParams): Promise<void>Parameters
- openCalendarItemParams
- OpenCalendarItemParams
object containing unique ID of the calendar item to be opened.
Returns
Promise<void>