Conference

The Conference model allows the application to get information about a conference.

Accessors

alias

• get alias(): string

Gets the conference alias.

Returns: string


id

• get id(): string

Gets the conference ID.

Returns: string


isAudioOnly

• get isAudioOnly(): boolean

A boolean that indicates whether a conference was created as audio-only.

Returns: boolean


isNew

• get isNew(): boolean

The property indicating if the created conference is new.

Returns: boolean


isProtected

• get isProtected(): boolean

A boolean that indicates whether a conference uses a conference access token and enhanced conference access control.

Returns: boolean


params

• get params(): ConferenceParameters

Gets the conference parameters.

Returns: ConferenceParameters


participants

• get participants(): Map<string, Participant>

Gets the list of the conference participants.

Returns: Map<string, Participant>


permissions

• get permissions(): Set<ConferencePermission>

Gets a list of the local participant's conference permissions.

Returns: Set<ConferencePermission>


pinCode

• get pinCode(): string

Gets the PIN code of the conference.

Returns: string


status

• get status(): ConferenceStatus

Gets the conference status.

Returns: ConferenceStatus


Did this page help you?