/ fm / liveswitch / WssPingMessage

Class: WssPingMessage

fm.liveswitch.WssPingMessage

Represents a WebSocket Ping message with a transaction identifier.

Table of contents

Constructors

• constructor

Methods

• getTransactionId
• getTypeString
• toString
• parse

Constructors

constructor

+ new WssPingMessage(transactionId: string): WssPingMessage

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

Parameters:

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

Returns: WssPingMessage

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

Methods

getTransactionId

▸ getTransactionId(): string

Gets the transaction identifier associated with this ping message.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/WssPingMessage.ts:60

---

getTypeString

▸ getTypeString(): string

Returns: string

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

---

toString

▸ toString(): string

Converts the ping message to its string representation.

Returns: string

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

Defined in: Generated/TypeScript/fm.liveswitch/WssPingMessage.ts:73

---

parse

▸ Staticparse(message: string): WssPingMessage

Parses a string representation of a ping message into a [[fm.liveswitch.wssPingMessage]] instance.

Parameters:

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

Returns: WssPingMessage

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

Defined in: Generated/TypeScript/fm.liveswitch/WssPingMessage.ts:41