NotificationService

The NotificationService allows the application to invite participants to the conference, decline conference invitations, and subscribe to and unsubscribe from notifications related to:

Events

invitationReceived

invitationReceived(notification: VTInvitationReceivedNotification)

Emitted after receiving an invitation.

Parameters:

NameType
notificationVTInvitationReceivedNotification

conferenceStatus

conferenceStatus(notification: VTConferenceStatusNotification)

Emitted when a conference has been subscribed.

Parameters:

NameType
notificationVTConferenceStatusNotification

conferenceCreated

conferenceCreated(notification: VTConferenceCreatedNotification)

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

Parameters:

NameType
notificationVTConferenceCreatedNotification

conferenceEnded

conferenceEnded(notification: VTConferenceEndedNotification)

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

Parameters:

NameType
notificationVTConferenceEndedNotification

participantJoined

participantJoined(notification: VTParticipantJoinedNotification)

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

Parameters:

NameType
notificationVTParticipantJoinedNotification

participantLeft

participantLeft(notification: VTParticipantLeftNotification)

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

Parameters:

NameType
notificationVTParticipantLeftNotification

Accessors

delegate

delegate: VTNotificationDelegate

Delegate, a means of communication between objects in the notification service.

Returns: VTNotificationDelegate

Methods

invite

invite(conference: VTConference, participantsInvited: VTParticipantInvited, completion: ((_ error: NSError?) -> Void)? = nil)

Notifies conference participants about a conference invitation. This method includes participants' permissions, which allow conference participants to perform a specific set of actions within a protected conference. 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. For more information about protected conferences, see the Enhanced Conference Access Control article.

Note: Use the invite method only after joining a conference.

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

Parameters:

NameTypeDefaultDescription
conferenceVTConference--
participantsInvited[VTParticipantInvited]--
completion((_ error: NSError?) -> Void)?nilThe block to execute when the query completes.

invite(conference: VTConference, participantInfos: [VTParticipantInfo], completion: ((_ error: NSError?) -> Void)? = nil)

Invites conference participants to the conference.

Note: Use the invite method only after joining a conference.

Parameters:

NameTypeDefaultDescription
conferenceVTConference--
VTParticipantInfos[VTParticipantInfo]--
completion((_ error: NSError?) -> Void)?nilThe block to execute when the query completes.

decline

decline(conference: VTConference, completion: ((_ error: NSError?) -> Void)? = nil)

Declines the conference invitation.

Parameters:

NameTypeDefaultDescription
conferenceVTConference--
completion((_ error: NSError?) -> Void)?nilThe block to execute when the query completes.

subscribe

subscribe(subscriptions: VTSubscribeBase, completion: ((_ error: NSError?) -> Void)?)

Turns on the subscription for the specified notification.

Parameters:

NameTypeDefaultDescription
subscriptions[VTSubscribeBase]--
completion((_ error: NSError?) -> Void)?nilThe block to execute when the query completes.

unsubscribe

unsubscribe(subscriptions: VTSubscribeBase, completion: ((_ error: NSError?) -> Void)?)

Turns off the subscription for the specified notification.

Parameters:

NameTypeDefaultDescription
subscriptions[VTSubscribeBase]--
completion((_ error: NSError?) -> Void)?nilThe block to execute when the query completes.