Class RSCommand

An RSCommand is a request from one side of the peer connection that some action be performed by the other side of the peer connection.

Hierarchy

RSCommand

Index

Constructors

Properties

acknowledgeOn category data msgid

Methods

Constructors

constructor

new RSCommand(msgid?: number, category?: number, data: RSTaggedData, acknowledgedOn: AcknowledgeOn): RSCommand
Construct an RSCommand.

Throws
If a required parameter is null.
Parameters
- msgid: number = 0
  
  Data transport message id
- category: number = Category.Default
  
  A number representing the type of the message.
- data: RSTaggedData
  
  An RSTaggedData containing information about the command to be executed.
- acknowledgedOn: AcknowledgeOn
  
  Enum value indicating when the other side of the connection should send an acknowledgement of the received command.
Returns RSCommand

Properties

acknowledgeOn

acknowledgeOn: AcknowledgeOn

Enum value indicating when the other side of the connection should send an acknowledgement of the received command.

category

category: number

A number representing the type of the message.

data

data: RSTaggedData

A piece of data containing information about the command to be executed.

msgid

msgid: number

Message ID

Methods

`Static` create

create(category?: number, data: RSTaggedData, acknowledgedOn: AcknowledgeOn): RSCommand
Construct an RSCommand.

Throws
If a required parameter is null.
Parameters
- category: number = Category.Default
  
  A number representing the type of the message.
- data: RSTaggedData
  
  An RSTaggedData containing information about the command to be executed.
- acknowledgedOn: AcknowledgeOn
  
  Enum value indicating when the other side of the connection should send an acknowledgement of the received command.
Returns RSCommand