Class ClientInfo

Client information.

Inheritance

System.Object

Info

ClientInfo

Inherited Members

Info.Id

Info.ProcessBoolean(Boolean, Boolean)

Info.ProcessShort(Int16, Int16)

Info.ProcessInteger(Int32, Int32)

Info.ProcessLong(Int64, Int64)

Info.ProcessFloat(Single, Single)

Info.ProcessDouble(Double, Double)

Info.ProcessString(String, String)

Info.ProcessBooleanArray(Boolean[], Boolean[])

Info.ProcessShortArray(Int16[], Int16[])

Info.ProcessIntegerArray(Int32[], Int32[])

Info.ProcessLongArray(Int64[], Int64[])

Info.ProcessFloatArray(Single[], Single[])

Info.ProcessFloatArray(Double[], Double[])

Info.ProcessObject<T>(T, T)

Info.ProcessArray<T>(T[], T[])

Namespace: FM.LiveSwitch

Assembly: FM.LiveSwitch.dll

Syntax

public class ClientInfo : Info

Constructors

ClientInfo()

Initializes a new instance of the ClientInfo class.

Declaration

public ClientInfo()

ClientInfo(String, String, String)

Initializes a new instance of the ClientInfo class.

Declaration

public ClientInfo(string userId, string deviceId, string id)

Parameters

Type	Name	Description
System.String	userId	The user identifier.
System.String	deviceId	The device identifier.
System.String	id	The client identifier.

ClientInfo(String, String, String, String, String, String, String[], String)

Initializes a new instance of the ClientInfo class.

Declaration

public ClientInfo(string userId, string userAlias, string deviceId, string deviceAlias, string id, string tag, string[] roles, string protocol)

Parameters

Type	Name	Description
System.String	userId	The user identifier.
System.String	userAlias	The user alias.
System.String	deviceId	The device identifier.
System.String	deviceAlias	The device alias.
System.String	id	The client identifier.
System.String	tag	The client tag.
System.String[]	roles	The client roles.
System.String	protocol	The client protocol.

ClientInfo(String, String, String, String, String, String, String[], String, String)

Initializes a new instance of the ClientInfo class.

Declaration

public ClientInfo(string userId, string userAlias, string deviceId, string deviceAlias, string id, string tag, string[] roles, string protocol, string region)

Parameters

Type	Name	Description
System.String	userId	The user identifier.
System.String	userAlias	The user alias.
System.String	deviceId	The device identifier.
System.String	deviceAlias	The device alias.
System.String	id	The client identifier.
System.String	tag	The client tag.
System.String[]	roles	The client roles.
System.String	protocol	The client protocol.
System.String	region	The client region.

Properties

ApplicationId

Gets or sets the application identifier.

Declaration

public string ApplicationId { get; set; }

Property Value

Type	Description
System.String

Architecture

Gets or sets the client architecture.

Declaration

public string Architecture { get; set; }

Property Value

Type	Description
System.String

CoreCount

Gets or sets the client core count.

Declaration

public int CoreCount { get; set; }

Property Value

Type	Description
System.Int32

DeviceAlias

Gets or sets the device alias.

Declaration

public string DeviceAlias { get; set; }

Property Value

Type	Description
System.String

DeviceId

Gets or sets the device identifier.

Declaration

public string DeviceId { get; set; }

Property Value

Type	Description
System.String

ExternalId

Gets or sets the client external identifier.

Declaration

public string ExternalId { get; set; }

Property Value

Type	Description
System.String

IsSip

Gets whether the client is connected via SIP.

Declaration

public bool IsSip { get; }

Property Value

Type	Description
System.Boolean

MachineName

Gets or sets the client machine name.

Declaration

public string MachineName { get; set; }

Property Value

Type	Description
System.String

OperatingSystem

Gets or sets the client operating system.

Declaration

public string OperatingSystem { get; set; }

Property Value

Type	Description
System.String

OperatingSystemVersion

Gets or sets the client operating system version.

Declaration

public string OperatingSystemVersion { get; set; }

Property Value

Type	Description
System.String

PhysicalMemory

Gets or sets the connector physical memory.

Declaration

public long PhysicalMemory { get; set; }

Property Value

Type	Description
System.Int64

Protocol

Gets or sets the client protocol.

Declaration

public string Protocol { get; set; }

Property Value

Type	Description
System.String

ProtocolSip

Gets the protocol string representing SIP.

Declaration

public static string ProtocolSip { get; }

Property Value

Type	Description
System.String

Region

Gets or sets the client region.

Declaration

public string Region { get; set; }

Property Value

Type	Description
System.String

Report

Gets or sets the client report.

Declaration

public ClientReport Report { get; set; }

Property Value

Type	Description
ClientReport

Roles

Gets or sets the client roles.

Declaration

public string[] Roles { get; set; }

Property Value

Type	Description
System.String[]

SourceLanguage

Gets or sets the client source language.

Declaration

public string SourceLanguage { get; set; }

Property Value

Type	Description
System.String

Tag

Gets or sets the client tag.

Declaration

public string Tag { get; set; }

Property Value

Type	Description
System.String

UserAlias

Gets or sets the user alias.

Declaration

public string UserAlias { get; set; }

Property Value

Type	Description
System.String

UserId

Gets or sets the user identifier.

Declaration

public string UserId { get; set; }

Property Value

Type	Description
System.String

Version

Gets or sets the client version.

Declaration

public string Version { get; set; }

Property Value

Type	Description
System.String

Methods

DeserializeProperties(String, String)

Deserializes the properties.

Declaration

protected override void DeserializeProperties(string key, string valueJson)

Parameters

Type	Name	Description
System.String	key	The key.
System.String	valueJson	The value in JSON format.

Overrides

Info.DeserializeProperties(String, String)

FromJson(String)

Deserializes an instance from JSON.

Declaration

public static ClientInfo FromJson(string clientInfoJson)

Parameters

Type	Name	Description
System.String	clientInfoJson	The JSON to deserialize.

Returns

Type	Description
ClientInfo	The deserialized client info.

FromJsonArray(String)

Deserializes an array of instances from JSON.

Declaration

public static ClientInfo[] FromJsonArray(string clientInfosJson)

Parameters

Type	Name	Description
System.String	clientInfosJson	The JSON to deserialize.

Returns

Type	Description
ClientInfo[]	The deserialized client infos.

IsEquivalent(ClientInfo)

Tests for equivalency.

Declaration

public bool IsEquivalent(ClientInfo clientInfo)

Parameters

Type	Name	Description
ClientInfo	clientInfo	The client information.

Returns

Type	Description
System.Boolean	true if equivalent; otherwise, false.

IsEquivalent(ConnectionInfo)

Tests for equivalency.

Declaration

public bool IsEquivalent(ConnectionInfo connectionInfo)

Parameters

Type	Name	Description
ConnectionInfo	connectionInfo	The connection information.

Returns

Type	Description
System.Boolean	true if equivalent; otherwise, false.

IsEquivalent(String, String, String)

Tests equivalency.

Declaration

public bool IsEquivalent(string userId, string deviceId, string id)

Parameters

Type	Name	Description
System.String	userId	The user identifier.
System.String	deviceId	The device identifier.
System.String	id	The client identifier.

Returns

Type	Description
System.Boolean	true if equivalent; otherwise, false.

SerializeProperties(Dictionary<String, String>)

Serializes the properties.

Declaration

protected override void SerializeProperties(Dictionary<string, string> jsonObject)

Parameters

Type	Name	Description
Dictionary<System.String, System.String>	jsonObject	The JSON object.

Overrides

Info.SerializeProperties(Dictionary<String, String>)

ToJson()

Serializes this instance to Json.

Declaration

public string ToJson()

Returns

Type	Description
System.String

ToJson(ClientInfo)

Serializes an instance to JSON.

Declaration

public static string ToJson(ClientInfo clientInfo)

Parameters

Type	Name	Description
ClientInfo	clientInfo	The client info to serialize.

Returns

Type	Description
System.String	The serialized JSON.

ToJsonArray(ClientInfo[])

Serializes an array of instances to JSON.

Declaration

public static string ToJsonArray(ClientInfo[] clientInfos)

Parameters

Type	Name	Description
ClientInfo[]	clientInfos	The client infos to serialize.

Returns

Type	Description
System.String	The serialized JSON.