Interface IScheduledCall

The details of a single occurrence of a scheduled call (or of any other calendar event).

interface IScheduledCall {
    allDay: boolean;
    attendees: ICallUser[];
    description?: string;
    duration: number;
    endsAt: string;
    external?: IScheduledCallExternalDetails;
    id: string;
    meetingUrl?: string;
    occurrence: string;
    organizer?: ICallUser;
    recurrence?: string;
    reminder?: number;
    startsAt: string;
    status: CallStatus;
    timeZone?: string;
    title?: string;
    type: CallEventType;
    viewerMetadata?: string;
}

Implemented by

Properties

allDay attendees description? duration endsAt external? id meetingUrl? occurrence organizer? recurrence? reminder? startsAt status timeZone? title? type viewerMetadata?

Properties

allDay

allDay: boolean

Whether the event lasts the whole day.

attendees

attendees: ICallUser[]

The users invited to the call.

Optionaldescription

description?: string

The description of the call.

duration

duration: number

The duration of the occurrence, in minutes.

endsAt

endsAt: string

The date and time at which the occurrence ends.

Optionalexternal

external?: IScheduledCallExternalDetails

The details of the event, if it comes from a linked external calendar.

id

id: string

The id of the event (shared by all the occurrences of a recurring call).

OptionalmeetingUrl

meetingUrl?: string

The url to join the call.

occurrence

occurrence: string

The original start of the occurrence, identifying it within a recurring call.

Remarks

Use this value as the occurrence option when acting on a single occurrence of a recurring call.

Optionalorganizer

organizer?: ICallUser

The user who organized the call.

Optionalrecurrence

recurrence?: string

The recurrence rule (RFC 5545 RRULE) of the call, if it is a recurring call.

Optionalreminder

reminder?: number

The number of minutes before the call at which the logged-in user is reminded of it.

startsAt

startsAt: string

The date and time at which the occurrence starts.

status

status: CallStatus

The status of the occurrence.

OptionaltimeZone

timeZone?: string

The time zone of the call.

Optionaltitle

title?: string

The title of the call.

type

type: CallEventType

The type of the event.

OptionalviewerMetadata

viewerMetadata?: string

The JSON-encoded metadata (color, visibility) set by the logged-in user on the call.

Settings

Member Visibility

On This Page

Properties