FMLiveSwitchClientInfo Class Reference

Client information. More...

Instance Methods

(NSString *) - applicationId
 Gets the application identifier. More...
 
(NSString *) - architecture
 Gets the client architecture. More...
 
(int) - coreCount
 Gets the client core count. More...
 
(void) - deserializePropertiesWithKey:valueJson:
 Deserializes the properties. More...
 
(NSString *) - deviceAlias
 Gets the device alias. More...
 
(NSString *) - deviceId
 Gets the device identifier. More...
 
(NSString *) - externalId
 Gets the client external identifier. More...
 
(instancetype) - init
 Initializes a new instance of the FMLiveSwitchClientInfo class. More...
 
(instancetype) - initWithUserId:deviceId:id:
 Initializes a new instance of the FMLiveSwitchClientInfo class. More...
 
(instancetype) - initWithUserId:userAlias:deviceId:deviceAlias:id:tag:roles:protocol:
 Initializes a new instance of the FMLiveSwitchClientInfo class. More...
 
(instancetype) - initWithUserId:userAlias:deviceId:deviceAlias:id:tag:roles:protocol:region:
 Initializes a new instance of the FMLiveSwitchClientInfo class. More...
 
(bool) - isEquivalentWithClientInfo:
 Tests for equivalency. More...
 
(bool) - isEquivalentWithConnectionInfo:
 Tests for equivalency. More...
 
(bool) - isEquivalentWithUserId:deviceId:id:
 Tests equivalency. More...
 
(bool) - isSip
 Gets whether the client is connected via SIP. More...
 
(NSString *) - machineName
 Gets the client machine name. More...
 
(NSString *) - operatingSystem
 Gets the client operating system. More...
 
(NSString *) - operatingSystemVersion
 Gets the client operating system version. More...
 
(long long) - physicalMemory
 Gets the connector physical memory. More...
 
(NSString *) - protocol
 Gets the client protocol. More...
 
(NSString *) - region
 Gets the client region. More...
 
(FMLiveSwitchClientReport *) - report
 Gets the client report. More...
 
(NSMutableArray *) - roles
 Gets the client roles. More...
 
(void) - serializePropertiesWithJsonObject:
 Serializes the properties. More...
 
(void) - setApplicationId:
 Sets the application identifier. More...
 
(void) - setArchitecture:
 Sets the client architecture. More...
 
(void) - setCoreCount:
 Sets the client core count. More...
 
(void) - setDeviceAlias:
 Sets the device alias. More...
 
(void) - setDeviceId:
 Sets the device identifier. More...
 
(void) - setExternalId:
 Sets the client external identifier. More...
 
(void) - setMachineName:
 Sets the client machine name. More...
 
(void) - setOperatingSystem:
 Sets the client operating system. More...
 
(void) - setOperatingSystemVersion:
 Sets the client operating system version. More...
 
(void) - setPhysicalMemory:
 Sets the connector physical memory. More...
 
(void) - setProtocol:
 Sets the client protocol. More...
 
(void) - setRegion:
 Sets the client region. More...
 
(void) - setReport:
 Sets the client report. More...
 
(void) - setRoles:
 Sets the client roles. More...
 
(void) - setSourceLanguage:
 Sets the client source language. More...
 
(void) - setTag:
 Sets the client tag. More...
 
(void) - setUserAlias:
 Sets the user alias. More...
 
(void) - setUserId:
 Sets the user identifier. More...
 
(void) - setVersion:
 Sets the client version. More...
 
(NSString *) - sourceLanguage
 Gets the client source language. More...
 
(NSString *) - tag
 Gets the client tag. More...
 
(NSString *) - toJson
 Serializes this instance to Json. More...
 
(NSString *) - userAlias
 Gets the user alias. More...
 
(NSString *) - userId
 Gets the user identifier. More...
 
(NSString *) - version
 Gets the client version. More...
 
- Instance Methods inherited from FMLiveSwitchInfo
(NSString *) - id
 Gets the identifier. More...
 
(void) - setId:
 Sets the identifier. More...
 

Class Methods

(FMLiveSwitchClientInfo *) + clientInfo
 Initializes a new instance of the FMLiveSwitchClientInfo class. More...
 
(FMLiveSwitchClientInfo *) + clientInfoWithUserId:deviceId:id:
 Initializes a new instance of the FMLiveSwitchClientInfo class. More...
 
(FMLiveSwitchClientInfo *) + clientInfoWithUserId:userAlias:deviceId:deviceAlias:id:tag:roles:protocol:
 Initializes a new instance of the FMLiveSwitchClientInfo class. More...
 
(FMLiveSwitchClientInfo *) + clientInfoWithUserId:userAlias:deviceId:deviceAlias:id:tag:roles:protocol:region:
 Initializes a new instance of the FMLiveSwitchClientInfo class. More...
 
(NSMutableArray *) + fromJsonArrayWithClientInfosJson:
 Deserializes an array of instances from JSON. More...
 
(FMLiveSwitchClientInfo *) + fromJsonWithClientInfoJson:
 Deserializes an instance from JSON. More...
 
(NSString *) + protocolSip
 Gets the protocol string representing SIP. More...
 
(NSString *) + toJsonArrayWithClientInfos:
 Serializes an array of instances to JSON. More...
 
(NSString *) + toJsonWithClientInfo:
 Serializes an instance to JSON. More...
 
- Class Methods inherited from FMLiveSwitchInfo
(FMLiveSwitchInfo *) + info
 
(NSMutableArray *) + processArrayWithNewValues:oldValues:
 Processes an array for an info. More...
 
(NSMutableArray *) + processBooleanArrayWithNewValues:oldValues:
 Processes a boolean array for an info. More...
 
(FMLiveSwitchNullableBool *) + processBooleanWithNewValue:oldValue:
 Processes a boolean for an info. More...
 
(FMLiveSwitchNullableDouble *) + processDoubleWithNewValue:oldValue:
 Processes a double for an info. More...
 
(NSMutableArray *) + processFloatArrayWithNewValues:oldValues:
 Processes a float array for an info. More...
 
(FMLiveSwitchNullableFloat *) + processFloatWithNewValue:oldValue:
 Processes a float for an info. More...
 
(NSMutableArray *) + processIntegerArrayWithNewValues:oldValues:
 Processes a integer array for an info. More...
 
(FMLiveSwitchNullableInt *) + processIntegerWithNewValue:oldValue:
 Processes an integer for an info. More...
 
(NSMutableArray *) + processLongArrayWithNewValues:oldValues:
 Processes a long array for an info. More...
 
(FMLiveSwitchNullableLong *) + processLongWithNewValue:oldValue:
 Processes a long for an info. More...
 
(NSObject< FMLiveSwitchIEquivalent > *) + processObjectWithNewValue:oldValue:
 Processes an object for an info. More...
 
(NSMutableArray *) + processShortArrayWithNewValues:oldValues:
 Processes a short array for an info. More...
 
(FMLiveSwitchNullableShort *) + processShortWithNewValue:oldValue:
 Processes a short for an info. More...
 
(NSString *) + processStringWithNewValue:oldValue:
 Processes a string for an info. More...
 

Detailed Description

Client information.

Method Documentation

◆ applicationId

- (NSString*) applicationId

Gets the application identifier.

◆ architecture

- (NSString*) architecture

Gets the client architecture.

◆ clientInfo

+ (FMLiveSwitchClientInfo*) clientInfo

Initializes a new instance of the FMLiveSwitchClientInfo class.

◆ clientInfoWithUserId:deviceId:id:

+ (FMLiveSwitchClientInfo*) clientInfoWithUserId: (NSString *)  userId
deviceId: (NSString *)  deviceId
id: (NSString *)  idValue 

Initializes a new instance of the FMLiveSwitchClientInfo class.

Parameters
userIdThe user identifier.
deviceIdThe device identifier.
idValueThe client identifier.

◆ clientInfoWithUserId:userAlias:deviceId:deviceAlias:id:tag:roles:protocol:

+ (FMLiveSwitchClientInfo*) clientInfoWithUserId: (NSString *)  userId
userAlias: (NSString *)  userAlias
deviceId: (NSString *)  deviceId
deviceAlias: (NSString *)  deviceAlias
id: (NSString *)  idValue
tag: (NSString *)  tag
roles: (NSMutableArray *)  roles
protocol: (NSString *)  protocol 

Initializes a new instance of the FMLiveSwitchClientInfo class.

Parameters
userIdThe user identifier.
userAliasThe user alias.
deviceIdThe device identifier.
deviceAliasThe device alias.
idValueThe client identifier.
tagThe client tag.
rolesThe client roles.
protocolThe client protocol.

◆ clientInfoWithUserId:userAlias:deviceId:deviceAlias:id:tag:roles:protocol:region:

+ (FMLiveSwitchClientInfo*) clientInfoWithUserId: (NSString *)  userId
userAlias: (NSString *)  userAlias
deviceId: (NSString *)  deviceId
deviceAlias: (NSString *)  deviceAlias
id: (NSString *)  idValue
tag: (NSString *)  tag
roles: (NSMutableArray *)  roles
protocol: (NSString *)  protocol
region: (NSString *)  region 

Initializes a new instance of the FMLiveSwitchClientInfo class.

Parameters
userIdThe user identifier.
userAliasThe user alias.
deviceIdThe device identifier.
deviceAliasThe device alias.
idValueThe client identifier.
tagThe client tag.
rolesThe client roles.
protocolThe client protocol.
regionThe client region.

◆ coreCount

- (int) coreCount

Gets the client core count.

◆ deserializePropertiesWithKey:valueJson:

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

Deserializes the properties.

Parameters
keyThe key.
valueJsonThe value in JSON format.

Implements FMLiveSwitchInfo.

◆ deviceAlias

- (NSString*) deviceAlias

Gets the device alias.

◆ deviceId

- (NSString*) deviceId

Gets the device identifier.

◆ externalId

- (NSString*) externalId

Gets the client external identifier.

◆ fromJsonArrayWithClientInfosJson:

+ (NSMutableArray*) fromJsonArrayWithClientInfosJson: (NSString *)  clientInfosJson

Deserializes an array of instances from JSON.

Parameters
clientInfosJsonThe JSON to deserialize.
Returns
The deserialized client infos.

◆ fromJsonWithClientInfoJson:

+ (FMLiveSwitchClientInfo*) fromJsonWithClientInfoJson: (NSString *)  clientInfoJson

Deserializes an instance from JSON.

Parameters
clientInfoJsonThe JSON to deserialize.
Returns
The deserialized client info.

◆ init

- (instancetype) init

Initializes a new instance of the FMLiveSwitchClientInfo class.

Implements FMLiveSwitchInfo.

◆ initWithUserId:deviceId:id:

- (instancetype) initWithUserId: (NSString *)  userId
deviceId: (NSString *)  deviceId
id: (NSString *)  idValue 

Initializes a new instance of the FMLiveSwitchClientInfo class.

Parameters
userIdThe user identifier.
deviceIdThe device identifier.
idValueThe client identifier.

◆ initWithUserId:userAlias:deviceId:deviceAlias:id:tag:roles:protocol:

- (instancetype) initWithUserId: (NSString *)  userId
userAlias: (NSString *)  userAlias
deviceId: (NSString *)  deviceId
deviceAlias: (NSString *)  deviceAlias
id: (NSString *)  idValue
tag: (NSString *)  tag
roles: (NSMutableArray *)  roles
protocol: (NSString *)  protocol 

Initializes a new instance of the FMLiveSwitchClientInfo class.

Parameters
userIdThe user identifier.
userAliasThe user alias.
deviceIdThe device identifier.
deviceAliasThe device alias.
idValueThe client identifier.
tagThe client tag.
rolesThe client roles.
protocolThe client protocol.

◆ initWithUserId:userAlias:deviceId:deviceAlias:id:tag:roles:protocol:region:

- (instancetype) initWithUserId: (NSString *)  userId
userAlias: (NSString *)  userAlias
deviceId: (NSString *)  deviceId
deviceAlias: (NSString *)  deviceAlias
id: (NSString *)  idValue
tag: (NSString *)  tag
roles: (NSMutableArray *)  roles
protocol: (NSString *)  protocol
region: (NSString *)  region 

Initializes a new instance of the FMLiveSwitchClientInfo class.

Parameters
userIdThe user identifier.
userAliasThe user alias.
deviceIdThe device identifier.
deviceAliasThe device alias.
idValueThe client identifier.
tagThe client tag.
rolesThe client roles.
protocolThe client protocol.
regionThe client region.

◆ isEquivalentWithClientInfo:

- (bool) isEquivalentWithClientInfo: (FMLiveSwitchClientInfo *)  clientInfo

Tests for equivalency.

Parameters
clientInfoThe client information.
Returns
true if equivalent; otherwise, false.

◆ isEquivalentWithConnectionInfo:

- (bool) isEquivalentWithConnectionInfo: (FMLiveSwitchConnectionInfo *)  connectionInfo

Tests for equivalency.

Parameters
connectionInfoThe connection information.
Returns
true if equivalent; otherwise, false.

◆ isEquivalentWithUserId:deviceId:id:

- (bool) isEquivalentWithUserId: (NSString *)  userId
deviceId: (NSString *)  deviceId
id: (NSString *)  idValue 

Tests equivalency.

Parameters
userIdThe user identifier.
deviceIdThe device identifier.
idValueThe client identifier.
Returns
true if equivalent; otherwise, false.

◆ isSip

- (bool) isSip

Gets whether the client is connected via SIP.

◆ machineName

- (NSString*) machineName

Gets the client machine name.

◆ operatingSystem

- (NSString*) operatingSystem

Gets the client operating system.

◆ operatingSystemVersion

- (NSString*) operatingSystemVersion

Gets the client operating system version.

◆ physicalMemory

- (long long) physicalMemory

Gets the connector physical memory.

◆ protocol

- (NSString*) protocol

Gets the client protocol.

◆ protocolSip

+ (NSString*) protocolSip

Gets the protocol string representing SIP.

◆ region

- (NSString*) region

Gets the client region.

◆ report

Gets the client report.

◆ roles

- (NSMutableArray*) roles

Gets the client roles.

◆ serializePropertiesWithJsonObject:

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

Serializes the properties.

Parameters
jsonObjectThe JSON object.

Implements FMLiveSwitchInfo.

◆ setApplicationId:

- (void) setApplicationId: (NSString *)  value

Sets the application identifier.

◆ setArchitecture:

- (void) setArchitecture: (NSString *)  value

Sets the client architecture.

◆ setCoreCount:

- (void) setCoreCount: (int)  value

Sets the client core count.

◆ setDeviceAlias:

- (void) setDeviceAlias: (NSString *)  value

Sets the device alias.

◆ setDeviceId:

- (void) setDeviceId: (NSString *)  value

Sets the device identifier.

◆ setExternalId:

- (void) setExternalId: (NSString *)  value

Sets the client external identifier.

◆ setMachineName:

- (void) setMachineName: (NSString *)  value

Sets the client machine name.

◆ setOperatingSystem:

- (void) setOperatingSystem: (NSString *)  value

Sets the client operating system.

◆ setOperatingSystemVersion:

- (void) setOperatingSystemVersion: (NSString *)  value

Sets the client operating system version.

◆ setPhysicalMemory:

- (void) setPhysicalMemory: (long long)  value

Sets the connector physical memory.

◆ setProtocol:

- (void) setProtocol: (NSString *)  value

Sets the client protocol.

◆ setRegion:

- (void) setRegion: (NSString *)  value

Sets the client region.

◆ setReport:

- (void) setReport: (FMLiveSwitchClientReport *)  value

Sets the client report.

◆ setRoles:

- (void) setRoles: (NSMutableArray *)  value

Sets the client roles.

◆ setSourceLanguage:

- (void) setSourceLanguage: (NSString *)  value

Sets the client source language.

◆ setTag:

- (void) setTag: (NSString *)  value

Sets the client tag.

◆ setUserAlias:

- (void) setUserAlias: (NSString *)  value

Sets the user alias.

◆ setUserId:

- (void) setUserId: (NSString *)  value

Sets the user identifier.

◆ setVersion:

- (void) setVersion: (NSString *)  value

Sets the client version.

◆ sourceLanguage

- (NSString*) sourceLanguage

Gets the client source language.

◆ tag

- (NSString*) tag

Gets the client tag.

◆ toJson

- (NSString*) toJson

Serializes this instance to Json.

◆ toJsonArrayWithClientInfos:

+ (NSString*) toJsonArrayWithClientInfos: (NSMutableArray *)  clientInfos

Serializes an array of instances to JSON.

Parameters
clientInfosThe client infos to serialize.
Returns
The serialized JSON.

◆ toJsonWithClientInfo:

+ (NSString*) toJsonWithClientInfo: (FMLiveSwitchClientInfo *)  clientInfo

Serializes an instance to JSON.

Parameters
clientInfoThe client info to serialize.
Returns
The serialized JSON.

◆ userAlias

- (NSString*) userAlias

Gets the user alias.

◆ userId

- (NSString*) userId

Gets the user identifier.

◆ version

- (NSString*) version

Gets the client version.