FMLiveSwitchChannelDeviceLayoutConfig Class Reference

Channel device layout configuration. More...

Instance Methods

(void) - deserializePropertiesWithKey:valueJson:
 Deserializes the properties. More...
 
(NSMutableArray *) - excludedClientIds
 Gets the client identifiers to exclude. More...
 
(NSMutableArray *) - excludedConnectionIds
 Gets the connection identifiers to exclude. More...
 
(instancetype) - init
 
(void) - serializePropertiesWithJsonObject:
 Serializes the properties. More...
 
(void) - setExcludedClientIds:
 Sets the client identifiers to exclude. More...
 
(void) - setExcludedConnectionIds:
 Sets the connection identifiers to exclude. More...
 
(NSString *) - toJson
 Serializes this channel device layout configuration to JSON. More...
 
- Instance Methods inherited from FMLiveSwitchLayoutConfig
(FMLiveSwitchNullableInt *) - priority
 Gets the layout proirity. More...
 
(void) - setPriority:
 Sets the layout proirity. More...
 
(void) - setZone:
 Sets the layout zone. More...
 
(NSString *) - zone
 Gets the layout zone. More...
 

Class Methods

(FMLiveSwitchChannelDeviceLayoutConfig *) + channelDeviceLayoutConfig
 
(FMLiveSwitchChannelDeviceLayoutConfig *) + fromJsonWithChannelDeviceLayoutConfigJson:
 Deserializes a channel device layout config from JSON. More...
 
(NSString *) + toJsonWithChannelDeviceLayoutConfig:
 Serializes a channel device layout config to JSON. More...
 
- Class Methods inherited from FMLiveSwitchLayoutConfig
(FMLiveSwitchLayoutConfig *) + layoutConfig
 

Detailed Description

Channel device layout configuration.

Method Documentation

◆ channelDeviceLayoutConfig

+ (FMLiveSwitchChannelDeviceLayoutConfig*) channelDeviceLayoutConfig

◆ deserializePropertiesWithKey:valueJson:

- (void) deserializePropertiesWithKey: (NSString *)  key
valueJson: (NSString *)  valueJson 

Deserializes the properties.

Parameters
keyThe key.
valueJsonThe value in JSON format.

Implements FMLiveSwitchLayoutConfig.

◆ excludedClientIds

- (NSMutableArray*) excludedClientIds

Gets the client identifiers to exclude.

◆ excludedConnectionIds

- (NSMutableArray*) excludedConnectionIds

Gets the connection identifiers to exclude.

◆ fromJsonWithChannelDeviceLayoutConfigJson:

+ (FMLiveSwitchChannelDeviceLayoutConfig*) fromJsonWithChannelDeviceLayoutConfigJson: (NSString *)  channelDeviceLayoutConfigJson

Deserializes a channel device layout config from JSON.

Parameters
channelDeviceLayoutConfigJsonThe channel device layout configuration as JSON.
Returns
The channel device layout configuration.

◆ init

- (instancetype) init

◆ serializePropertiesWithJsonObject:

- (void) serializePropertiesWithJsonObject: (NSMutableDictionary< NSString *, NSString * > *)  jsonObject

Serializes the properties.

Parameters
jsonObjectThe JSON object.

Implements FMLiveSwitchLayoutConfig.

◆ setExcludedClientIds:

- (void) setExcludedClientIds: (NSMutableArray *)  value

Sets the client identifiers to exclude.

◆ setExcludedConnectionIds:

- (void) setExcludedConnectionIds: (NSMutableArray *)  value

Sets the connection identifiers to exclude.

◆ toJson

- (NSString*) toJson

Serializes this channel device layout configuration to JSON.

Returns
The channel device layout configuration as JSON.

◆ toJsonWithChannelDeviceLayoutConfig:

+ (NSString*) toJsonWithChannelDeviceLayoutConfig: (FMLiveSwitchChannelDeviceLayoutConfig *)  channelDeviceLayoutConfig

Serializes a channel device layout config to JSON.

Parameters
channelDeviceLayoutConfigThe channel device layout configuration.
Returns
The channel device layout configuration as JSON.