NotificationService

The NotificationService enables inviting participants to a conference. The service also allows subscribing to and unsubscribing from notifications informing about:

• The number of participants who are present at a conference
• Received conference invitations
• Created conferences
• Ended conferences
• Participants joining conferences
• Participants leaving conferences

Events

activeParticipants

• activeParticipants(e: ActiveParticipants): void

Emitted to notify an application user, who subscribed to SubscribeActiveParticipants, that a list of active participants is updated. The event informs how many participants joined a conference.

example

VoxeetSDK.notification.on("activeParticipants", (e) => {});

Parameters:

Returns: void

conferenceCreated

• conferenceCreated(e: ConferenceCreatedNotification): void

Emitted to notify an application user, who subscribed to SubscribeConferenceCreated, that a new conference was created.

example

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

Parameters:

Returns: void

conferenceEnded

• conferenceEnded(e: ConferenceEndedNotification): void

Emitted to notify an application user, who subscribed to SubscribeConferenceEnded, that a conference was ended.

example

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

Parameters:

Returns: void

conferenceStatus

• conferenceStatus(e: ConferenceStatusNotification): void

Emitted when the application user subscribed to any notification. The application emits the conferenceStatus event to inform the user about the status of the subscribed conference. This notification cannot be subscribed to.

example

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

Parameters:

Returns: void

invitation

• invitation(e: InvitationReceived): void

Emitted when the application user received an invitation. This notification is subscribed by default. For more information about invitations, see the Inviting Participants document.

example

VoxeetSDK.notification.on("invitation", (e) => {});

Parameters:

Returns: void

participantJoined

• participantJoined(e: ParticipantJoinedNotification): void

Emitted to notify an application user, who subscribed to SubscribeParticipantJoined, that a new participant joined a conference.

example

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

Parameters:

Returns: void

participantLeft

• participantLeft(e: ParticipantLeftNotification): void

Emitted to notify an application user, who subscribed to SubscribeParticipantLeft, that a participant left a conference.

example

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

Parameters:

Returns: void

Methods

invite

▸ invite(conference: Conference, participants: Array<ParticipantInfo>): Promise<void>

Notifies conference participants about a conference invitation. The ParticipantInfo model included in the invitation has to include externalId.

The Dolby.io Communications offer two invite methods. You can use invite with the ParticipantInfo or ParticipantInvited parameter:

• ParticipantInfo does not include participants' permissions.

• ParticipantInvited includes the participants' permissions, which allow conference participants to perform a specific set of actions within a protected conference. For more information about inviting participants with the specified permissions, see the next invite method that is described below.

Both invite methods include the Conference object:

• In the case of inviting participants to a conference that is not protected, inviters can invite participants to any conference.
• In the case of inviting participants to a protected conference, inviters can invite participants only to the current conference. Therefore, if you wish to invite participants to a protected conference, include in the invitation the Conference object related to the current conference.

var participants = [
  { name: "Guest 01", externalId: "guest-01", avatarUrl: "" },
];
await VoxeetSDK.notification.invite(conference, participants);

For more information about invitations, see the Inviting Participants article.

Parameters:

Returns: Promise<void>

--

invite

▸ invite(conference: Conference, invitedParticipants: Array<ParticipantInvited>): Promise<void>

Notifies conference participants about a conference invitation. This method includes participants' permissions.

Participants who have permission to invite additional participants to a conference can also use this method. In the invitation, inviters can only grant permissions that the inviters have. For example, a participant who does not have permission to record a conference can only invite new participants who also cannot record this conference.

Protected conferences require assigning proper conference permissions to all invited participants. However, the inviter can invite participants to a protected conference without specifying the participants' permissions. If permissions are not specified, the platform assigns the default permissions, which include Join, SendAudio, SendVideo, ShareScreen, ShareVideo, ShareFile, SendMessage, Record, and Stream.

If you wish to invite participants to a protected conference, use the invite method after joining the conference.

The invite method includes the Conference object. In the case of inviting participants to a protected conference, inviters can invite participants only to the current conference. Therefore, the invitation has to include the Conference object related to the current conference.

Parameters:

Returns: Promise<void>

subscribe

▸ subscribe(subscriptions: Array<BaseSubscription>): Promise<void>

Subscribes to the specified notifications.

Examples:

// Subscribes to the Participant.Joined event
await VoxeetSDK.notification.subscribe([
    {
        type: "Participant.Joined",
        conferenceAlias: "yourConferenceAlias",
    }
]);

// Subscribes to the conference.Created and conference.Ended events
await VoxeetSDK.notification.subscribe([
    {
        type: "Conference.Created",
        conferenceAlias: "yourConferenceAlias"
    },
    {
        type: "Conference.Ended",
        conferenceAlias: "yourConferenceAlias"
    },
]);

Parameters:

Returns: Promise<void>

unsubscribe

▸ unsubscribe(subscriptions: Array<BaseSubscription>): Promise<void>

Unsubscribes from the specified notifications.

Example:

// Unsubscribes from the invitation event
await VoxeetSDK.notification.unsubscribe([
    { type: "Invitation" }
]);

Parameters:

Returns: Promise<void>