NotificationService
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, 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 |
---|---|---|
conference | VTConference | - |
participantInfos | [VTParticipantInfo] | - |
completion | ((_ error: NSError?) -> Void)? | nil |
decline
▸ decline(conference
: VTConference, completion
: ((_ error: NSError?) -> Void)? = nil)
Declines the conference invitation.
Parameters:
Name | Type | Default |
---|---|---|
conference | VTConference | - |
completion | ((_ error: NSError?) -> Void)? | nil |
subscribe
▸ subscribe(subscriptions
: [VTSubscribeBase], completion
: ((_ error: NSError?) -> Void)?)
Turns on the subscription for the specified notification.
Parameters:
Name | Type | Default |
---|---|---|
subscriptions | [VTSubscribeBase] | - |
completion | ((_ error: NSError?) -> Void)? | nil |
unsubscribe
▸ unsubscribe(subscriptions
: [VTSubscribeBase], completion
: ((_ error: NSError?) -> Void)?)
Turns off the subscription for the specified notification.
Parameters:
Name | Type | Default |
---|---|---|
subscriptions | [VTSubscribeBase] | - |
completion | ((_ error: NSError?) -> Void)? | nil |