FMLiveSwitchWssPingMessage Class Reference

Represents a WebSocket Ping message with a transaction identifier. More...

Instance Methods

(NSString *) - description
 Converts the ping message to its string representation. More...
 
(instancetype) - initWithTransactionId:
 Initializes a new instance of the FMLiveSwitchWssPingMessage class. More...
 
(NSString *) - transactionId
 Gets the transaction identifier associated with this ping message. More...
 

Class Methods

(FMLiveSwitchWssPingMessage *) + parseWithMessage:
 Parses a string representation of a ping message into a FMLiveSwitchWssPingMessage instance. More...
 
(FMLiveSwitchWssPingMessage *) + wssPingMessageWithTransactionId:
 Initializes a new instance of the FMLiveSwitchWssPingMessage class. More...
 

Detailed Description

Represents a WebSocket Ping message with a transaction identifier.

Method Documentation

◆ description

- (NSString*) description

Converts the ping message to its string representation.

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

◆ initWithTransactionId:

- (instancetype) initWithTransactionId: (NSString *)  transactionId

Initializes a new instance of the FMLiveSwitchWssPingMessage class.

Parameters
transactionIdThe transaction identifier for the ping message.

◆ parseWithMessage:

+ (FMLiveSwitchWssPingMessage*) parseWithMessage: (NSString *)  message

Parses a string representation of a ping message into a FMLiveSwitchWssPingMessage instance.

Parameters
messageThe string to parse, which should be in the format "ls-ping {transactionId}".
Returns
A new instance of FMLiveSwitchWssPingMessage containing the parsed transaction ID.

◆ transactionId

- (NSString*) transactionId

Gets the transaction identifier associated with this ping message.

◆ wssPingMessageWithTransactionId:

+ (FMLiveSwitchWssPingMessage*) wssPingMessageWithTransactionId: (NSString *)  transactionId

Initializes a new instance of the FMLiveSwitchWssPingMessage class.

Parameters
transactionIdThe transaction identifier for the ping message.