FMLiveSwitchChannelLayoutConfig Class Reference

Channel 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...
 
(NSMutableArray *) - excludedDeviceIds
 Gets the device identifiers to exclude. More...
 
(NSMutableArray *) - excludedUserIds
 Gets the user 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...
 
(void) - setExcludedDeviceIds:
 Sets the device identifiers to exclude. More...
 
(void) - setExcludedUserIds:
 Sets the user identifiers to exclude. More...
 
(NSString *) - toJson
 Serializes this channel 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

(FMLiveSwitchChannelLayoutConfig *) + channelLayoutConfig
 
(FMLiveSwitchChannelLayoutConfig *) + fromJsonWithChannelLayoutConfigJson:
 Deserializes a channel layout config from JSON. More...
 
(NSString *) + toJsonWithChannelLayoutConfig:
 Serializes a channel layout config to JSON. More...
 
- Class Methods inherited from FMLiveSwitchLayoutConfig
(FMLiveSwitchLayoutConfig *) + layoutConfig
 

Detailed Description

Channel layout configuration.

Method Documentation

◆ channelLayoutConfig

+ (FMLiveSwitchChannelLayoutConfig*) channelLayoutConfig

◆ 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.

◆ excludedDeviceIds

- (NSMutableArray*) excludedDeviceIds

Gets the device identifiers to exclude.

◆ excludedUserIds

- (NSMutableArray*) excludedUserIds

Gets the user identifiers to exclude.

◆ fromJsonWithChannelLayoutConfigJson:

+ (FMLiveSwitchChannelLayoutConfig*) fromJsonWithChannelLayoutConfigJson: (NSString *)  channelLayoutConfigJson

Deserializes a channel layout config from JSON.

Parameters
channelLayoutConfigJsonThe channel layout configuration as JSON.
Returns
The channel 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.

◆ setExcludedDeviceIds:

- (void) setExcludedDeviceIds: (NSMutableArray *)  value

Sets the device identifiers to exclude.

◆ setExcludedUserIds:

- (void) setExcludedUserIds: (NSMutableArray *)  value

Sets the user identifiers to exclude.

◆ toJson

- (NSString*) toJson

Serializes this channel layout configuration to JSON.

Returns
The channel layout configuration as JSON.

◆ toJsonWithChannelLayoutConfig:

+ (NSString*) toJsonWithChannelLayoutConfig: (FMLiveSwitchChannelLayoutConfig *)  channelLayoutConfig

Serializes a channel layout config to JSON.

Parameters
channelLayoutConfigThe layout configuration.
Returns
The channel layout configuration as JSON.