Interface CreateEventRequest

Interface representing a request to create an event.

Hierarchy

  • CreateEventRequest

Properties

busy? calendarId? capacity? conferencing? description? hideParticipants? location? metadata? participants? readOnly? recurrence? reminders? title? visibility? when

Properties

Optional busy

busy?: boolean

This value determines whether to show this event's time block as available on shared or public calendars.

Optional calendarId

calendarId?: string

Calendar ID of the event.

Optional capacity

capacity?: number

The maximum number of participants that may attend the event.

Optional conferencing

conferencing?: Conferencing

Representation of conferencing details for events. Conferencing object can be in one of two formats (sub-objects):

Optional description

description?: string

Description of the event.

Optional hideParticipants

hideParticipants?: boolean

Whether participants of the event should be hidden.

Optional location

location?: string

Location of the event, such as a physical address or meeting room name.

Optional metadata

metadata?: Record<string, unknown>

A list of key-value pairs storing additional data.

Optional participants

participants?: Participant[]

List of participants invited to the event. Participants may also be rooms or resources.

Optional readOnly

readOnly?: boolean

If the event participants are able to edit the event.

Optional recurrence

recurrence?: string[]

An list of RRULE and EXDATE strings.

See

RFC-5545

Optional reminders

reminders?: Reminders

A list of reminders to send for the event. If left empty or omitted, the event uses the provider defaults.

Optional title

title?: string

Title of the event.

Optional visibility

visibility?: "private" | "public"

Visibility of the event, if the event is private or public.

when

when: CreateWhen

Representation of time and duration for events. When object can be in one of four formats (sub-objects):

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc