SessionService
The SessionService allows the application to register the local participant's information in the Voxeet service. The service allows opening and closing sessions. The application needs to open a session before interacting with any service.
Accessors
delegate
▸ delegate: VTSessionDelegate
Delegate, a means of communication between objects in the session service.
Returns: VTSessionDelegate
participant
▸ participant: VTParticipant
Provides the local participant object that belongs to the current session.
Returns: VTParticipant
Methods
open
▸ open(options
: VTParticipantInfo?, completion
: ((_ error: NSError?) -> Void)?)
Opens a new session.
Parameters:
Name | Type | Default | Description |
---|---|---|---|
options | VTParticipantInfo | nil | The optional information about the local participant. |
completion | ((_ error: NSError?) -> Void)? | nil | The block to execute when the query completes. |
isOpen
▸ isOpen() -> Bool
Checks whether there is an open session that connects SDK with backend.
Returns: Bool
close
▸ close(completion
: ((_ error: NSError?) -> Void)?)
Closes the current session.
Name | Type | Default | Description |
---|---|---|---|
completion | ((_ error: NSError?) -> Void)? | nil | The block to execute when the query completes. |
Updated over 1 year ago