/ fm / liveswitch / WssPongMessage

Class: WssPongMessage

fm.liveswitch.WssPongMessage

Represents a WebSocket Pong message with a transaction identifier.

Table of contents

Constructors

• constructor

Methods

• getTransactionId
• getTypeString
• toString
• parse

Constructors

constructor

+ new WssPongMessage(ping: WssPingMessage): WssPongMessage

Initializes a new instance of the [[fm.liveswitch.wssPongMessage]] class with the same transaction ID as the ping message.

Parameters:

Name	Type	Description
ping	WssPingMessage	The ping message to respond to.

Returns: WssPongMessage

Defined in: Generated/TypeScript/fm.liveswitch/WssPongMessage.ts:13

+ new WssPongMessage(transactionId: string): WssPongMessage

Initializes a new instance of the [[fm.liveswitch.wssPongMessage]] class.

Parameters:

Name	Type	Description
transactionId	string	The transaction identifier for the pong message.

Returns: WssPongMessage

Defined in: Generated/TypeScript/fm.liveswitch/WssPongMessage.ts:21

Methods

getTransactionId

▸ getTransactionId(): string

Gets the transaction identifier associated with this pong message.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/WssPongMessage.ts:72

---

getTypeString

▸ getTypeString(): string

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/WssPongMessage.ts:9

---

toString

▸ toString(): string

Converts the pong message to its string representation.

Returns: string

A string in the format "ls-pong {transactionId}".

Defined in: Generated/TypeScript/fm.liveswitch/WssPongMessage.ts:85

---

parse

▸ Staticparse(message: string): WssPongMessage

Parses a string representation of a pong message into a [[fm.liveswitch.wssPongMessage]] instance.

Parameters:

Name	Type	Description
message	string	The string to parse, which should be in the format "ls-pong {transactionId}".

Returns: WssPongMessage

A new instance of [[fm.liveswitch.wssPongMessage]] containing the parsed transaction ID.

Defined in: Generated/TypeScript/fm.liveswitch/WssPongMessage.ts:53