/ fm / liveswitch / ClientInfo
Class: ClientInfo
fm.liveswitch.ClientInfo
Client information.
Hierarchy
-
↳ ClientInfo
Table of contents
Constructors
Methods
- deserializeProperties
- fmliveswitchClientInfoInit
- getApplicationId
- getArchitecture
- getCoreCount
- getDeviceAlias
- getDeviceId
- getExternalId
- getId
- getIsSip
- getMachineName
- getOperatingSystem
- getOperatingSystemVersion
- getPhysicalMemory
- getProtocol
- getRegion
- getReport
- getRoles
- getSourceLanguage
- getTag
- getTypeString
- getUserAlias
- getUserId
- getVersion
- isEquivalent
- serializeProperties
- setApplicationId
- setArchitecture
- setCoreCount
- setDeviceAlias
- setDeviceId
- setExternalId
- setId
- setMachineName
- setOperatingSystem
- setOperatingSystemVersion
- setPhysicalMemory
- setProtocol
- setRegion
- setReport
- setRoles
- setSourceLanguage
- setTag
- setUserAlias
- setUserId
- setVersion
- toJson
- fromJson
- fromJsonArray
- getProtocolSip
- processArray
- processBoolean
- processBooleanArray
- processDouble
- processFloat
- processFloatArray
- processInteger
- processIntegerArray
- processLong
- processLongArray
- processObject
- processShort
- processShortArray
- processString
- toJson
- toJsonArray
Constructors
constructor
+ new ClientInfo(): ClientInfo
Initializes a new instance of the [[fm.liveswitch.clientInfo]] class.
Returns: ClientInfo
Inherited from: Info
Defined in: Generated/TypeScript/fm.liveswitch/ClientInfo.ts:56
+ new ClientInfo(userId
: string, deviceId
: string, idValue
: string): ClientInfo
Initializes a new instance of the [[fm.liveswitch.clientInfo]] class.
Parameters:
Name | Type | Description |
---|---|---|
userId |
string | The user identifier. |
deviceId |
string | The device identifier. |
idValue |
string | The client identifier. |
Returns: ClientInfo
Defined in: Generated/TypeScript/fm.liveswitch/ClientInfo.ts:62
+ new ClientInfo(userId
: string, userAlias
: string, deviceId
: string, deviceAlias
: string, idValue
: string, tag
: string, roles
: string[], protocol
: string): ClientInfo
Initializes a new instance of the [[fm.liveswitch.clientInfo]] class.
Parameters:
Name | Type | Description |
---|---|---|
userId |
string | The user identifier. |
userAlias |
string | The user alias. |
deviceId |
string | The device identifier. |
deviceAlias |
string | The device alias. |
idValue |
string | The client identifier. |
tag |
string | The client tag. |
roles |
string[] | The client roles. |
protocol |
string | The client protocol. |
Returns: ClientInfo
Defined in: Generated/TypeScript/fm.liveswitch/ClientInfo.ts:71
+ new ClientInfo(userId
: string, userAlias
: string, deviceId
: string, deviceAlias
: string, idValue
: string, tag
: string, roles
: string[], protocol
: string, region
: string): ClientInfo
Initializes a new instance of the [[fm.liveswitch.clientInfo]] class.
Parameters:
Name | Type | Description |
---|---|---|
userId |
string | The user identifier. |
userAlias |
string | The user alias. |
deviceId |
string | The device identifier. |
deviceAlias |
string | The device alias. |
idValue |
string | The client identifier. |
tag |
string | The client tag. |
roles |
string[] | The client roles. |
protocol |
string | The client protocol. |
region |
string | The client region. |
Returns: ClientInfo
Defined in: Generated/TypeScript/fm.liveswitch/ClientInfo.ts:85
Methods
deserializeProperties
▸ Protected
deserializeProperties(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: Info
Defined in: Generated/TypeScript/fm.liveswitch/ClientInfo.ts:338
fmliveswitchClientInfoInit
▸ Private
fmliveswitchClientInfoInit(): void
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ClientInfo.ts:52
getApplicationId
▸ getApplicationId(): string
Gets the application identifier.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/ClientInfo.ts:411
getArchitecture
▸ getArchitecture(): string
Gets the client architecture.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/ClientInfo.ts:423
getCoreCount
▸ getCoreCount(): number
Gets the client core count.
Returns: number
Defined in: Generated/TypeScript/fm.liveswitch/ClientInfo.ts:435
getDeviceAlias
▸ getDeviceAlias(): string
Gets the device alias.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/ClientInfo.ts:447
getDeviceId
▸ getDeviceId(): string
Gets the device identifier.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/ClientInfo.ts:459
getExternalId
▸ getExternalId(): string
Gets the client external identifier.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/ClientInfo.ts:471
getId
▸ getId(): string
Gets the identifier.
Returns: string
Inherited from: Info
Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:336
getIsSip
▸ getIsSip(): boolean
Gets whether the client is connected via SIP.
Returns: boolean
Defined in: Generated/TypeScript/fm.liveswitch/ClientInfo.ts:483
getMachineName
▸ getMachineName(): string
Gets the client machine name.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/ClientInfo.ts:495
getOperatingSystem
▸ getOperatingSystem(): string
Gets the client operating system.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/ClientInfo.ts:507
getOperatingSystemVersion
▸ getOperatingSystemVersion(): string
Gets the client operating system version.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/ClientInfo.ts:519
getPhysicalMemory
▸ getPhysicalMemory(): number
Gets the connector physical memory.
Returns: number
Defined in: Generated/TypeScript/fm.liveswitch/ClientInfo.ts:531
getProtocol
▸ getProtocol(): string
Gets the client protocol.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/ClientInfo.ts:543
getRegion
▸ getRegion(): string
Gets the client region.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/ClientInfo.ts:555
getReport
▸ getReport(): ClientReport
Gets the client report.
Returns: ClientReport
Defined in: Generated/TypeScript/fm.liveswitch/ClientInfo.ts:567
getRoles
▸ getRoles(): string[]
Gets the client roles.
Returns: string[]
Defined in: Generated/TypeScript/fm.liveswitch/ClientInfo.ts:579
getSourceLanguage
▸ getSourceLanguage(): string
Gets the client source language.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/ClientInfo.ts:591
getTag
▸ getTag(): string
Gets the client tag.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/ClientInfo.ts:603
getTypeString
▸ getTypeString(): string
Returns: string
Overrides: Info
Defined in: Generated/TypeScript/fm.liveswitch/ClientInfo.ts:10
getUserAlias
▸ getUserAlias(): string
Gets the user alias.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/ClientInfo.ts:615
getUserId
▸ getUserId(): string
Gets the user identifier.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/ClientInfo.ts:627
getVersion
▸ getVersion(): string
Gets the client version.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/ClientInfo.ts:639
isEquivalent
▸ isEquivalent(clientInfo
: ClientInfo): boolean
Tests for equivalency.
Parameters:
Name | Type | Description |
---|---|---|
clientInfo |
ClientInfo | The client information. |
Returns: boolean
true
if equivalent; otherwise, false
.
Defined in: Generated/TypeScript/fm.liveswitch/ClientInfo.ts:665
▸ isEquivalent(connectionInfo
: ConnectionInfo): boolean
Tests for equivalency.
Parameters:
Name | Type | Description |
---|---|---|
connectionInfo |
ConnectionInfo | The connection information. |
Returns: boolean
true
if equivalent; otherwise, false
.
Defined in: Generated/TypeScript/fm.liveswitch/ClientInfo.ts:674
▸ isEquivalent(userId
: string, deviceId
: string, idValue
: string): boolean
Tests equivalency.
Parameters:
Name | Type | Description |
---|---|---|
userId |
string | The user identifier. |
deviceId |
string | The device identifier. |
idValue |
string | The client identifier. |
Returns: boolean
true
if equivalent; otherwise, false
.
Defined in: Generated/TypeScript/fm.liveswitch/ClientInfo.ts:685
serializeProperties
▸ Protected
serializeProperties(jsonObject
: Hash<string, string>): void
Serializes the properties.
Parameters:
Name | Type | Description |
---|---|---|
jsonObject |
Hash<string, string> | The JSON object. |
Returns: void
Overrides: Info
Defined in: Generated/TypeScript/fm.liveswitch/ClientInfo.ts:708
setApplicationId
▸ setApplicationId(value
: string): void
Sets the application identifier.
Parameters:
Name | Type |
---|---|
value |
string |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ClientInfo.ts:777
setArchitecture
▸ setArchitecture(value
: string): void
Sets the client architecture.
Parameters:
Name | Type |
---|---|
value |
string |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ClientInfo.ts:789
setCoreCount
▸ setCoreCount(value
: number): void
Sets the client core count.
Parameters:
Name | Type |
---|---|
value |
number |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ClientInfo.ts:801
setDeviceAlias
▸ setDeviceAlias(value
: string): void
Sets the device alias.
Parameters:
Name | Type |
---|---|
value |
string |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ClientInfo.ts:814
setDeviceId
▸ setDeviceId(value
: string): void
Sets the device identifier.
Parameters:
Name | Type |
---|---|
value |
string |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ClientInfo.ts:826
setExternalId
▸ setExternalId(value
: string): void
Sets the client external identifier.
Parameters:
Name | Type |
---|---|
value |
string |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ClientInfo.ts:838
setId
▸ setId(value
: string): void
Sets the identifier.
Parameters:
Name | Type |
---|---|
value |
string |
Returns: void
Inherited from: Info
Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:363
setMachineName
▸ setMachineName(value
: string): void
Sets the client machine name.
Parameters:
Name | Type |
---|---|
value |
string |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ClientInfo.ts:850
setOperatingSystem
▸ setOperatingSystem(value
: string): void
Sets the client operating system.
Parameters:
Name | Type |
---|---|
value |
string |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ClientInfo.ts:862
setOperatingSystemVersion
▸ setOperatingSystemVersion(value
: string): void
Sets the client operating system version.
Parameters:
Name | Type |
---|---|
value |
string |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ClientInfo.ts:874
setPhysicalMemory
▸ setPhysicalMemory(value
: number): void
Sets the connector physical memory.
Parameters:
Name | Type |
---|---|
value |
number |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ClientInfo.ts:886
setProtocol
▸ setProtocol(value
: string): void
Sets the client protocol.
Parameters:
Name | Type |
---|---|
value |
string |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ClientInfo.ts:899
setRegion
▸ setRegion(value
: string): void
Sets the client region.
Parameters:
Name | Type |
---|---|
value |
string |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ClientInfo.ts:911
setReport
▸ setReport(value
: ClientReport): void
Sets the client report.
Parameters:
Name | Type |
---|---|
value |
ClientReport |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ClientInfo.ts:923
setRoles
▸ setRoles(value
: string[]): void
Sets the client roles.
Parameters:
Name | Type |
---|---|
value |
string[] |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ClientInfo.ts:935
setSourceLanguage
▸ setSourceLanguage(value
: string): void
Sets the client source language.
Parameters:
Name | Type |
---|---|
value |
string |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ClientInfo.ts:947
setTag
▸ setTag(value
: string): void
Sets the client tag.
Parameters:
Name | Type |
---|---|
value |
string |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ClientInfo.ts:959
setUserAlias
▸ setUserAlias(value
: string): void
Sets the user alias.
Parameters:
Name | Type |
---|---|
value |
string |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ClientInfo.ts:971
setUserId
▸ setUserId(value
: string): void
Sets the user identifier.
Parameters:
Name | Type |
---|---|
value |
string |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ClientInfo.ts:983
setVersion
▸ setVersion(value
: string): void
Sets the client version.
Parameters:
Name | Type |
---|---|
value |
string |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/ClientInfo.ts:995
toJson
▸ toJson(): string
Serializes this instance to Json.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/ClientInfo.ts:1007
fromJson
▸ Static
fromJson(clientInfoJson
: string): ClientInfo
Deserializes an instance from JSON.
Parameters:
Name | Type | Description |
---|---|---|
clientInfoJson |
string | The JSON to deserialize. |
Returns: ClientInfo
The deserialized client info.
Defined in: Generated/TypeScript/fm.liveswitch/ClientInfo.ts:242
fromJsonArray
▸ Static
fromJsonArray(clientInfosJson
: string): ClientInfo[]
Deserializes an array of instances from JSON.
Parameters:
Name | Type | Description |
---|---|---|
clientInfosJson |
string | The JSON to deserialize. |
Returns: ClientInfo[]
The deserialized client infos.
Defined in: Generated/TypeScript/fm.liveswitch/ClientInfo.ts:262
getProtocolSip
▸ Static
getProtocolSip(): string
Gets the protocol string representing SIP.
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/ClientInfo.ts:278
processArray
▸ Static
processArray<T>(newValues
: T[], oldValues
: T[]): T[]
Processes an array for an info.
Type parameters:
Name | Type |
---|---|
T |
IEquivalent<T, T> |
Parameters:
Name | Type | Description |
---|---|---|
newValues |
T[] | The new values. |
oldValues |
T[] | The old values. |
Returns: T[]
The new values, if the new values are not equivalent to the old values; otherwise null.
Inherited from: Info
Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:34
processBoolean
▸ Static
processBoolean(newValue
: boolean, oldValue
: boolean): boolean
Processes a boolean for an info.
Parameters:
Name | Type | Description |
---|---|---|
newValue |
boolean | The new value. |
oldValue |
boolean | The old value. |
Returns: boolean
The new value, if the new value does not equal the old value; otherwise null.
Inherited from: Info
Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:60
processBooleanArray
▸ Static
processBooleanArray(newValues
: boolean[], oldValues
: boolean[]): boolean[]
Processes a boolean array for an info.
Parameters:
Name | Type | Description |
---|---|---|
newValues |
boolean[] | The new values. |
oldValues |
boolean[] | The old values. |
Returns: boolean[]
The new values, if the new values do not equal the old values; otherwise null.
Inherited from: Info
Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:75
processDouble
▸ Static
processDouble(newValue
: number, oldValue
: number): number
Processes a double for an info.
Parameters:
Name | Type | Description |
---|---|---|
newValue |
number | The new value. |
oldValue |
number | The old value. |
Returns: number
The new value, if the new value does not equal the old value; otherwise null.
Inherited from: Info
Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:101
processFloat
▸ Static
processFloat(newValue
: number, oldValue
: number): number
Processes a float for an info.
Parameters:
Name | Type | Description |
---|---|---|
newValue |
number | The new value. |
oldValue |
number | The old value. |
Returns: number
The new value, if the new value does not equal the old value; otherwise null.
Inherited from: Info
Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:116
processFloatArray
▸ Static
processFloatArray(newValues
: number[], oldValues
: number[]): number[]
Processes a float array for an info.
Parameters:
Name | Type | Description |
---|---|---|
newValues |
number[] | The new values. |
oldValues |
number[] | The old values. |
Returns: number[]
The new values, if the new values do not equal the old values; otherwise null.
Inherited from: Info
Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:131
processInteger
▸ Static
processInteger(newValue
: number, oldValue
: number): number
Processes an integer for an info.
Parameters:
Name | Type | Description |
---|---|---|
newValue |
number | The new value. |
oldValue |
number | The old value. |
Returns: number
The new value, if the new value does not equal the old value; otherwise null.
Inherited from: Info
Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:157
processIntegerArray
▸ Static
processIntegerArray(newValues
: number[], oldValues
: number[]): number[]
Processes a integer array for an info.
Parameters:
Name | Type | Description |
---|---|---|
newValues |
number[] | The new values. |
oldValues |
number[] | The old values. |
Returns: number[]
The new values, if the new values do not equal the old values; otherwise null.
Inherited from: Info
Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:174
processLong
▸ Static
processLong(newValue
: number, oldValue
: number): number
Processes a long for an info.
Parameters:
Name | Type | Description |
---|---|---|
newValue |
number | The new value. |
oldValue |
number | The old value. |
Returns: number
The new value, if the new value does not equal the old value; otherwise null.
Inherited from: Info
Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:200
processLongArray
▸ Static
processLongArray(newValues
: number[], oldValues
: number[]): number[]
Processes a long array for an info.
Parameters:
Name | Type | Description |
---|---|---|
newValues |
number[] | The new values. |
oldValues |
number[] | The old values. |
Returns: number[]
The new values, if the new values do not equal the old values; otherwise null.
Inherited from: Info
Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:217
processObject
▸ Static
processObject<T>(newValue
: T, oldValue
: T): T
Processes an object for an info.
Type parameters:
Name | Type |
---|---|
T |
Object & IEquivalent<T, T> |
Parameters:
Name | Type | Description |
---|---|---|
newValue |
T | The new value. |
oldValue |
T | The old value. |
Returns: T
The new value, if the new value does not equal the old value; otherwise null.
Inherited from: Info
Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:243
processShort
▸ Static
processShort(newValue
: number, oldValue
: number): number
Processes a short for an info.
Parameters:
Name | Type | Description |
---|---|---|
newValue |
number | The new value. |
oldValue |
number | The old value. |
Returns: number
The new value, if the new value does not equal the old value; otherwise null.
Inherited from: Info
Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:264
processShortArray
▸ Static
processShortArray(newValues
: number[], oldValues
: number[]): number[]
Processes a short array for an info.
Parameters:
Name | Type | Description |
---|---|---|
newValues |
number[] | The new values. |
oldValues |
number[] | The old values. |
Returns: number[]
The new values, if the new values do not equal the old values; otherwise null.
Inherited from: Info
Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:281
processString
▸ Static
processString(newValue
: string, oldValue
: string): string
Processes a string for an info.
Parameters:
Name | Type | Description |
---|---|---|
newValue |
string | The new value. |
oldValue |
string | The old value. |
Returns: string
The new value, if the new value does not equal the old value; otherwise null.
Inherited from: Info
Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:307
toJson
▸ Static
toJson(clientInfo
: ClientInfo): string
Serializes an instance to JSON.
Parameters:
Name | Type | Description |
---|---|---|
clientInfo |
ClientInfo | The client info to serialize. |
Returns: string
The serialized JSON.
Defined in: Generated/TypeScript/fm.liveswitch/ClientInfo.ts:294
toJsonArray
▸ Static
toJsonArray(clientInfos
: ClientInfo[]): string
Serializes an array of instances to JSON.
Parameters:
Name | Type | Description |
---|---|---|
clientInfos |
ClientInfo[] | The client infos to serialize. |
Returns: string
The serialized JSON.
Defined in: Generated/TypeScript/fm.liveswitch/ClientInfo.ts:312