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

• received conference invitations
• created conferences
• ended conferences
• participants joining conferences
• participants leaving conferences

Events

invitationReceived

▸ invitationReceived(notification: VTInvitationReceivedNotification)

Emitted after receiving an invitation.

Parameters:

Name	Type
notification	VTInvitationReceivedNotification

conferenceStatus

▸ conferenceStatus(notification: VTConferenceStatusNotification)

Emitted when a conference has been subscribed.

Parameters:

Name	Type
notification	VTConferenceStatusNotification

conferenceCreated

▸ conferenceCreated(notification: VTConferenceCreatedNotification)

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

Parameters:

Name	Type
notification	VTConferenceCreatedNotification

conferenceEnded

▸ conferenceEnded(notification: VTConferenceEndedNotification)

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

Parameters:

Name	Type
notification	VTConferenceEndedNotification

participantJoined

▸ participantJoined(notification: VTParticipantJoinedNotification)

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

Parameters:

Name	Type
notification	VTParticipantJoinedNotification

participantLeft

▸ participantLeft(notification: VTParticipantLeftNotification)

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

Parameters:

Name	Type
notification	VTParticipantLeftNotification

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:

Name	Type	Default	Description
conference	VTConference	-	-
participantsInvited	[VTParticipantInvited]	-	-
completion	((_ error: NSError?) -> Void)?	nil	The 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:

Name	Type	Default	Description
conference	VTConference	-	-
VTParticipantInfos	[VTParticipantInfo]	-	-
completion	((_ error: NSError?) -> Void)?	nil	The block to execute when the query completes.

decline

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

Declines the conference invitation.

Parameters:

Name	Type	Default	Description
conference	VTConference	-	-
completion	((_ error: NSError?) -> Void)?	nil	The block to execute when the query completes.

subscribe

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

Turns on the subscription for the specified notification.

Parameters:

Name	Type	Default	Description
subscriptions	[VTSubscribeBase]	-	-
completion	((_ error: NSError?) -> Void)?	nil	The block to execute when the query completes.

unsubscribe

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

Turns off the subscription for the specified notification.

Parameters:

Name	Type	Default	Description
subscriptions	[VTSubscribeBase]	-	-
completion	((_ error: NSError?) -> Void)?	nil	The block to execute when the query completes.