Expand Minimize Picture-in-picture Power Device Status Voice Recognition Skip Back Skip Forward Minus Plus Play Search
Documentation
RpcMessage

RpcMessage Class Reference

Constructors

Instance Methods

Constructors

new RpcMessage(store)

Initializes an instance of RpcMessage.

Instance Methods

rpcMessage.getBulkData() ⇒ Uint8Array

Get the bulk data.

Kind: Instance method of RpcMessage
Returns: Uint8Array - Bulk data as a byte array.

rpcMessage.getCorrelationId() ⇒ String

Get the correlation ID.

Kind: Instance method of RpcMessage
Returns: String - The correlation ID.

rpcMessage.getFunctionId() ⇒ FunctionID

Get the FunctionID name.

Kind: Instance method of RpcMessage
Returns: FunctionID - A FunctionID enum key.

rpcMessage.getMessageType() ⇒ MessageType

Get the MessageType enum value.

Kind: Instance method of RpcMessage
Returns: MessageType - A MessageType enum value.

rpcMessage.isPayloadProtected() ⇒ Boolean

Get whether or not it is encrypted.

Kind: Instance method of RpcMessage
Returns: Boolean - Whether or not it is encrypted.

rpcMessage.setBulkData(data) ⇒ RpcMessage

Set the bulk data.

Kind: Instance method of RpcMessage
Returns: RpcMessage - A reference of this class to support method chaining.

ParamTypeDescription
data UInt8Array Bulk data as a byte array.

rpcMessage.setCorrelationId(id) ⇒ RpcMessage

Set the correlation ID.

Kind: Instance method of RpcMessage
Returns: RpcMessage - A reference of this class to support method chaining.

ParamTypeDescription
id String The correlation ID.

rpcMessage.setFunctionId(name) ⇒ RpcMessage

Set the FunctionID enum key. If a FunctionID enum value is provided, it will attempted to be automatically converted into the matching key.

Kind: Instance method of RpcMessage
Returns: RpcMessage - A reference of this class to support method chaining.

ParamTypeDescription
name FunctionID A FunctionID enum key.

rpcMessage.setMessageType(type) ⇒ RpcMessage

Set the MessageType enum value.

Kind: Instance method of RpcMessage
Returns: RpcMessage - A reference of this class to support method chaining.

ParamTypeDescription
type MessageType A MessageType enum value.

rpcMessage.setPayloadProtected(bool) ⇒ RpcMessage

Set whether or not it is encrypted.

Kind: Instance method of RpcMessage
Returns: RpcMessage - A reference of this class to support method chaining.

ParamTypeDescription
bool Boolean Whether or not it is encrypted.
View on GitHub.com
Previous Section Next Section