2020 API AWARDS WINNER - BEST IN MEDIA APIs LEARN MORE

NotificationService

The NotificationService enables an application to subscribe to and unsubscribe from a few types of notifications that are related to:

Events

conferenceCreated

conferenceCreated(e: ConferenceCreatedNotification): void

Emitted after receiving the subscribed notification related to a created conference.

example

VoxeetSDK.notification.on("conferenceCreated", () => {

});

Parameters:

NameType
eConferenceCreatedNotification

Returns: void


conferenceEnded

conferenceEnded(e: ConferenceEndedNotification): void

Emitted after receiving the subscribed notification related to an ended conference.

example

VoxeetSDK.notification.on("conferenceEnded", () => {

});

Parameters:

NameType
eConferenceEndedNotification

Returns: void


conferenceStatus

conferenceStatus(e: ConferenceStatusNotification): void

Emitted after a subscription to provide the initial status of a conference.

example

VoxeetSDK.notification.on("conferenceStatus", () => {

});

Parameters:

NameType
eConferenceStatusNotification

Returns: void


invitation

invitation(e: InvitationReceived): void

Emitted after receiving the subscribed notification related to an invitation.

example

VoxeetSDK.notification.on("invitation", (e: InvitationReceived) => {

});

Parameters:

NameType
eInvitationReceived

Returns: void


participantJoined

participantJoined(e: ParticipantJoinedNotification): void

Emitted after receiving the subscribed notification about a participant that has joined a conference.

example

VoxeetSDK.notification.on("participantJoined", () => {

});

Parameters:

NameType
eParticipantJoinedNotification

Returns: void


participantLeft

participantLeft(e: ParticipantLeftNotification): void

Emitted after receiving the subscribed notification about a participant that has left a conference.

example

VoxeetSDK.notification.on("participantLeft", () => {

});

Parameters:

NameType
eParticipantLeftNotification

Returns: void

Methods

subscribe

subscribe(subscriptions: Array‹BaseSubscription›): any

Turns on the subscription for the specified notifications.

Parameters:

NameTypeDescription
subscriptionsArray‹BaseSubscription

Returns: any


unsubscribe

unsubscribe(subscriptions: Array‹BaseSubscription›): any

Turns off the subscription for the specified notifications.

Parameters:

NameTypeDescription
subscriptionsArray‹BaseSubscription

Returns: any