CommandService
The CommandService allows the application to send text messages or notifications to all conference participants. The service also emits an received event to inform the application about received messages.
Events
received
▸ received(participant
: VTParticipant, message
: String)
Emitted when a participant receives a message.
Parameters:
Name | Type | Description |
---|---|---|
participant | VTParticipant | The participant who sent the message. |
message | String | The received message. |
Accessors
delegate
▸ delegate: VTCommandDelegate
Delegate, a means of communication between objects in the command service.
Returns: VTCommandDelegate
Methods
send
▸ send(message
: String, completion
: ((_ error: NSError?) -> Void)?)
Sends a message, in the form of a string, to all conference participants. Message size is limited to 16KB. This method is not available for mixed listeners.
Parameters:
Name | Type | Default | Description |
---|---|---|---|
message | String | - | The message to send. |
completion | ((_ error: NSError?) -> Void)? | nil | The block to execute when the query completes. |
Updated about 1 month ago