Class SignallingMessage

constructor

• new SignallingMessage(options?: SignallingMessageOptions): SignallingMessage

  Parameters

  • options: SignallingMessageOptions = {}

  Returns SignallingMessage

candidate

description

descriptionType

error

mid

recipient

sender

type

toJson

• toJson(): StatusOr<string>

  Encode the signalling message as JSON text.

  Returns StatusOr<string>

toJsonValue

• toJsonValue(): StatusOr<Record<string, unknown>>

  Convert to the interoperable signalling JSON object.

  Returns StatusOr<Record<string, unknown>>

validate

• validate(): Status

  Check fields required by the selected message kind.

  Returns Status

Staticcreate

• create(options?: SignallingMessageOptions): StatusOr<SignallingMessage>

  Construct and validate a message before sending it to a peer.

  Parameters

  • options: SignallingMessageOptions = {}

  Returns StatusOr<SignallingMessage>

StaticfromJson

• fromJson(encoded: string): StatusOr<SignallingMessage>

  Parse and validate signalling JSON text from an untrusted peer.

  Parameters

  • encoded: string

  Returns StatusOr<SignallingMessage>

StaticfromJsonValue

• fromJsonValue(value: unknown): StatusOr<SignallingMessage>

  Parse and validate an already-decoded signalling JSON value.

  Parameters

  • value: unknown

  Returns StatusOr<SignallingMessage>