NotificationService

The NotificationService allows inviting participants to a conference and subscribing to and unsubscribing from notifications.

Methods

subscribe

ā–ø subscribe(events): Promise<void>

šŸš€

SDK Beta

This model is a part of the Beta program.

Subscribes to the specified notifications.

Parameters

NameTypeDescription
eventsSubscription[]An array of the subscribed subscription types.

Returns

Promise<void>


unsubscribe

ā–ø unsubscribe(events): Promise<void>

šŸš€

SDK Beta

This model is a part of the Beta program.

Unsubscribes from the specified notifications.

Parameters

NameTypeDescription
eventsSubscription[]An array of the subscribed subscription types.

Returns

Promise<void>


decline

ā–ø decline(conference): Promise<void>

Declines the conference invitation.

Parameters

NameTypeDescription
conferenceConferenceThe conference object.

Returns

Promise<void>


invite

ā–ø invite(conference, participants): Promise<void>

Notifies conference participants about a conference invitation.

Parameters

NameTypeDescription
conferenceConferenceThe conference object.
participantsParticipantInvited[]Information about the invited application users.

Returns

Promise<void>


Event handlers

onInvitationReceived

ā–ø onInvitationReceived(handler): UnsubscribeFunction

Adds a listener to the invitation received event.

Parameters

NameTypeDescription
handler(data: InvitationReceivedEventType) => voidAn event callback function.

Returns

UnsubscribeFunction

A function that unsubscribes from event listeners.


onConferenceStatus

ā–ø onConferenceStatus(handler): UnsubscribeFunction

šŸš€

SDK Beta

This model is a part of the Beta program.

Adds a listener to the conference status event.

Parameters

NameTypeDescription
handler(data: ConferenceStatusEventType) => voidAn event callback function.

Returns

UnsubscribeFunction

A function that unsubscribes from event listeners.


onConferenceCreated

ā–ø onConferenceCreated(handler): UnsubscribeFunction

šŸš€

SDK Beta

This model is a part of the Beta program.

Adds a listener to the conference created event.

Parameters

NameTypeDescription
handler(data: ConferenceCreatedEventType) => voidAn event callback function.

Returns

UnsubscribeFunction

A function that unsubscribes from event listeners.


onConferenceEnded

ā–ø onConferenceEnded(handler): UnsubscribeFunction

šŸš€

SDK Beta

This model is a part of the Beta program.

Adds a listener to the conference ended event.

Parameters

NameTypeDescription
handler(data: ConferenceEndedEventType) => voidAn event callback function.

Returns

UnsubscribeFunction

A function that unsubscribes from event listeners.


onParticipantJoined

ā–ø onParticipantJoined(handler): UnsubscribeFunction

šŸš€

SDK Beta

This model is a part of the Beta program.

Adds a listener to the participant joined event.

Parameters

NameTypeDescription
handler(data: ParticipantJoinedEventType) => voidAn event callback function.

Returns

UnsubscribeFunction

A function that unsubscribes from event listeners.


onParticipantLeft

ā–ø onParticipantLeft(handler): UnsubscribeFunction

šŸš€

SDK Beta

This model is a part of the Beta program.

Adds a listener to the participant left event.

Parameters

NameTypeDescription
handler(data: ParticipantLeftEventType) => voidAn event callback function.

Returns

UnsubscribeFunction

A function that unsubscribes from event listeners.


onActiveParticipants

ā–ø onActiveParticipants(handler): UnsubscribeFunction

šŸš€

SDK Beta

This model is a part of the Beta program.

Adds a listener to the participant active event.

Parameters

NameTypeDescription
handler(data: ActiveParticipantsEventType) => voidAn event callback function.

Returns

UnsubscribeFunction

A function that unsubscribes from event listeners.