/ fm / liveswitch / ClientConfig
Class: ClientConfig
fm.liveswitch.ClientConfig
Client configuration.
Table of contents
Methods
- getDeviceAlias
- getRoles
- getTag
- getTypeString
- getUserAlias
- setDeviceAlias
- setRoles
- setTag
- setUserAlias
- toJson
- fromJson
- toJson
Methods
getDeviceAlias
▸ getDeviceAlias(): string
Gets the Device Alias.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/ClientConfig.ts:104
getRoles
▸ getRoles(): string[]
Gets the Roles.
Returns: string[]
Defined in: Generated/TypeScript/fm.liveswitch/ClientConfig.ts:116
getTag
▸ getTag(): string
Gets the Tag.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/ClientConfig.ts:128
getTypeString
▸ getTypeString(): string
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/ClientConfig.ts:9
getUserAlias
▸ getUserAlias(): string
Gets the User Alias.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/ClientConfig.ts:140
setDeviceAlias
▸ setDeviceAlias(value
: string): void
Sets the Device Alias.
Parameters:
Name | Type |
---|---|
value |
string |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ClientConfig.ts:152
setRoles
▸ setRoles(value
: string[]): void
Sets the Roles.
Parameters:
Name | Type |
---|---|
value |
string[] |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ClientConfig.ts:164
setTag
▸ setTag(value
: string): void
Sets the Tag.
Parameters:
Name | Type |
---|---|
value |
string |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ClientConfig.ts:176
setUserAlias
▸ setUserAlias(value
: string): void
Sets the User Alias.
Parameters:
Name | Type |
---|---|
value |
string |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ClientConfig.ts:188
toJson
▸ toJson(): string
Serializes this instance to JSON.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/ClientConfig.ts:200
fromJson
▸ Static
fromJson(clientConfigJson
: string): ClientConfig
Deserializes an instance from JSON.
Parameters:
Name | Type | Description |
---|---|---|
clientConfigJson |
string | The JSON to deserialize. |
Returns: ClientConfig
The deserialized client config.
Defined in: Generated/TypeScript/fm.liveswitch/ClientConfig.ts:42
toJson
▸ Static
toJson(clientConfig
: ClientConfig): string
Serializes an instance to JSON.
Parameters:
Name | Type | Description |
---|---|---|
clientConfig |
ClientConfig | The client config to serialize. |
Returns: string
The serialized JSON.
Defined in: Generated/TypeScript/fm.liveswitch/ClientConfig.ts:79