FMLiveSwitchWebSocketCloseArgs Class Reference

Close arguments for the FMLiveSwitchWebSocket class. More...

Instance Methods

(instancetype) - init
 Creates a new instance of FMLiveSwitchWebSocketCloseArgs with default values. More...
 
(FMLiveSwitchAction1< FMLiveSwitchWebSocketCloseCompleteArgs * > *) - onComplete
 Gets the callback to execute when the connection is closed. More...
 
(NSString *) - reason
 Gets the reason to send with the close frame. More...
 
(void) - setOnComplete:
 Sets the callback to execute when the connection is closed. More...
 
(FMLiveSwitchWebSocketCloseCompleteArgs *) - setOnCompleteBlock
 Sets the callback to execute when the connection is closed. More...
 
(void) - setOnCompleteBlock:
 Sets the callback to execute when the connection is closed. More...
 
(void) - setReason:
 Sets the reason to send with the close frame. More...
 
(void) - setStatusCode:
 Sets the status code to send with the close frame. More...
 
(FMLiveSwitchWebSocketStatusCode) - statusCode
 Gets the status code to send with the close frame. More...
 
- Instance Methods inherited from FMLiveSwitchDynamic
(NSMutableDictionary< NSString *, id > *) - dynamicProperties
 Gets all dynamic properties on this instance. More...
 
(id- getDynamicValueWithKey:
 Gets a property value from the local cache. More...
 
(void) - setDynamicValueWithKey:value:
 Sets a property value in the local cache. More...
 
(bool) - unsetDynamicValueWithKey:
 Removes a property value from the local cache. More...
 

Class Methods

(FMLiveSwitchWebSocketCloseArgs *) + webSocketCloseArgs
 Creates a new instance of FMLiveSwitchWebSocketCloseArgs with default values. More...
 
- Class Methods inherited from FMLiveSwitchDynamic
(FMLiveSwitchDynamic *) + dynamic
 
- Class Methods inherited from FMLiveSwitchSerializable
(FMLiveSwitchSerializable *) + serializable
 Initializes a new instance of the FMLiveSwitchSerializable class. More...
 

Detailed Description

Close arguments for the FMLiveSwitchWebSocket class.

Method Documentation

◆ init

- (instancetype) init

Creates a new instance of FMLiveSwitchWebSocketCloseArgs with default values.

Implements FMLiveSwitchDynamic.

◆ onComplete

- (FMLiveSwitchAction1<FMLiveSwitchWebSocketCloseCompleteArgs*>*) onComplete

Gets the callback to execute when the connection is closed.

◆ reason

- (NSString*) reason

Gets the reason to send with the close frame.

◆ setOnComplete:

- (void) setOnComplete: (FMLiveSwitchAction1< FMLiveSwitchWebSocketCloseCompleteArgs * > *)  value

Sets the callback to execute when the connection is closed.

◆ setOnCompleteBlock

- (FMLiveSwitchWebSocketCloseCompleteArgs*) setOnCompleteBlock

Sets the callback to execute when the connection is closed.

◆ setOnCompleteBlock:

- (void) setOnCompleteBlock: (void(^)(FMLiveSwitchWebSocketCloseCompleteArgs *))  valueBlock

Sets the callback to execute when the connection is closed.

◆ setReason:

- (void) setReason: (NSString *)  value

Sets the reason to send with the close frame.

◆ setStatusCode:

- (void) setStatusCode: (FMLiveSwitchWebSocketStatusCode)  value

Sets the status code to send with the close frame.

◆ statusCode

- (FMLiveSwitchWebSocketStatusCode) statusCode

Gets the status code to send with the close frame.

◆ webSocketCloseArgs

+ (FMLiveSwitchWebSocketCloseArgs*) webSocketCloseArgs

Creates a new instance of FMLiveSwitchWebSocketCloseArgs with default values.