FMLiveSwitchWssPongMessage Class Reference

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

Instance Methods

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

Class Methods

(FMLiveSwitchWssPongMessage *) + parseWithMessage:
 Parses a string representation of a pong message into a FMLiveSwitchWssPongMessage instance. More...
 
(FMLiveSwitchWssPongMessage *) + wssPongMessageWithPing:
 Initializes a new instance of the FMLiveSwitchWssPongMessage class with the same transaction ID as the ping message. More...
 
(FMLiveSwitchWssPongMessage *) + wssPongMessageWithTransactionId:
 Initializes a new instance of the FMLiveSwitchWssPongMessage class. More...
 

Detailed Description

Represents a WebSocket Pong message with a transaction identifier.

Method Documentation

◆ description

- (NSString*) description

Converts the pong message to its string representation.

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

◆ initWithPing:

- (instancetype) initWithPing: (FMLiveSwitchWssPingMessage *)  ping

Initializes a new instance of the FMLiveSwitchWssPongMessage class with the same transaction ID as the ping message.

Parameters
pingThe ping message to respond to.

◆ initWithTransactionId:

- (instancetype) initWithTransactionId: (NSString *)  transactionId

Initializes a new instance of the FMLiveSwitchWssPongMessage class.

Parameters
transactionIdThe transaction identifier for the pong message.

◆ parseWithMessage:

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

Parses a string representation of a pong message into a FMLiveSwitchWssPongMessage instance.

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

◆ transactionId

- (NSString*) transactionId

Gets the transaction identifier associated with this pong message.

◆ wssPongMessageWithPing:

+ (FMLiveSwitchWssPongMessage*) wssPongMessageWithPing: (FMLiveSwitchWssPingMessage *)  ping

Initializes a new instance of the FMLiveSwitchWssPongMessage class with the same transaction ID as the ping message.

Parameters
pingThe ping message to respond to.

◆ wssPongMessageWithTransactionId:

+ (FMLiveSwitchWssPongMessage*) wssPongMessageWithTransactionId: (NSString *)  transactionId

Initializes a new instance of the FMLiveSwitchWssPongMessage class.

Parameters
transactionIdThe transaction identifier for the pong message.