/ fm / liveswitch / ChannelUserLayoutConfig

Class: ChannelUserLayoutConfig

fm.liveswitch.ChannelUserLayoutConfig

Channel user layout configuration.

Hierarchy

• LayoutConfig

  ↳ ChannelUserLayoutConfig

Table of contents

Constructors

• constructor

Methods

• deserializeProperties
• getExcludedClientIds
• getExcludedConnectionIds
• getExcludedDeviceIds
• getPriority
• getTypeString
• getZone
• serializeProperties
• setExcludedClientIds
• setExcludedConnectionIds
• setExcludedDeviceIds
• setPriority
• setZone
• toJson
• fromJson
• toJson

Constructors

constructor

+ new ChannelUserLayoutConfig(): ChannelUserLayoutConfig

Returns: ChannelUserLayoutConfig

Inherited from: LayoutConfig

Defined in: Generated/TypeScript/fm.liveswitch/ChannelUserLayoutConfig.ts:18

Methods

deserializeProperties

▸ ProtecteddeserializeProperties(key: string, valueJson: string): void

Deserializes the properties.

Parameters:

Name	Type	Description
key	string	The key.
valueJson	string	The value in JSON format.

Returns: void

Overrides: LayoutConfig

Defined in: Generated/TypeScript/fm.liveswitch/ChannelUserLayoutConfig.ts:72

---

getExcludedClientIds

▸ getExcludedClientIds(): string[]

Gets the client identifiers to exclude.

Returns: string[]

Defined in: Generated/TypeScript/fm.liveswitch/ChannelUserLayoutConfig.ts:98

---

getExcludedConnectionIds

▸ getExcludedConnectionIds(): string[]

Gets the connection identifiers to exclude.

Returns: string[]

Defined in: Generated/TypeScript/fm.liveswitch/ChannelUserLayoutConfig.ts:110

---

getExcludedDeviceIds

▸ getExcludedDeviceIds(): string[]

Gets the device identifiers to exclude.

Returns: string[]

Defined in: Generated/TypeScript/fm.liveswitch/ChannelUserLayoutConfig.ts:122

---

getPriority

▸ getPriority(): number

Gets the layout proirity

Returns: number

Inherited from: LayoutConfig

Defined in: Generated/TypeScript/fm.liveswitch/LayoutConfig.ts:56

---

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: LayoutConfig

Defined in: Generated/TypeScript/fm.liveswitch/ChannelUserLayoutConfig.ts:10

---

getZone

▸ getZone(): string

Gets the layout zone

Returns: string

Inherited from: LayoutConfig

Defined in: Generated/TypeScript/fm.liveswitch/LayoutConfig.ts:68

---

serializeProperties

▸ ProtectedserializeProperties(jsonObject: Hash<string, string>): void

Serializes the properties.

Parameters:

Name	Type	Description
jsonObject	Hash<string, string>	The JSON object.

Returns: void

Overrides: LayoutConfig

Defined in: Generated/TypeScript/fm.liveswitch/ChannelUserLayoutConfig.ts:135

---

setExcludedClientIds

▸ setExcludedClientIds(value: string[]): void

Sets the client identifiers to exclude.

Parameters:

Name	Type
value	string[]

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ChannelUserLayoutConfig.ts:156

---

setExcludedConnectionIds

▸ setExcludedConnectionIds(value: string[]): void

Sets the connection identifiers to exclude.

Parameters:

Name	Type
value	string[]

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ChannelUserLayoutConfig.ts:168

---

setExcludedDeviceIds

▸ setExcludedDeviceIds(value: string[]): void

Sets the device identifiers to exclude.

Parameters:

Name	Type
value	string[]

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ChannelUserLayoutConfig.ts:180

---

setPriority

▸ setPriority(value: number): void

Sets the layout proirity

Parameters:

Name	Type
value	number

Returns: void

Inherited from: LayoutConfig

Defined in: Generated/TypeScript/fm.liveswitch/LayoutConfig.ts:98

---

setZone

▸ setZone(value: string): void

Sets the layout zone

Parameters:

Name	Type
value	string

Returns: void

Inherited from: LayoutConfig

Defined in: Generated/TypeScript/fm.liveswitch/LayoutConfig.ts:110

---

toJson

▸ toJson(): string

Serializes this channel user layout configuration to JSON.

Returns: string

The channel user layout configuration as JSON.

Defined in: Generated/TypeScript/fm.liveswitch/ChannelUserLayoutConfig.ts:193

---

fromJson

▸ StaticfromJson(channelUserLayoutConfigJson: string): ChannelUserLayoutConfig

Deserializes a channel user layout config from JSON.

Parameters:

Name	Type	Description
channelUserLayoutConfigJson	string	The channel user layout configuration as JSON.

Returns: ChannelUserLayoutConfig

The channel user layout configuration.

Defined in: Generated/TypeScript/fm.liveswitch/ChannelUserLayoutConfig.ts:38

---

toJson

▸ StatictoJson(channelUserLayoutConfig: ChannelUserLayoutConfig): string

Serializes a channel user layout config to JSON.

Parameters:

Name	Type	Description
channelUserLayoutConfig	ChannelUserLayoutConfig	The channel user layout configuration.

Returns: string

The channel user layout configuration as JSON.

Defined in: Generated/TypeScript/fm.liveswitch/ChannelUserLayoutConfig.ts:56