Client information. More...

Public Member Functions
	ClientInfo ()
	Initializes a new instance of the fm.liveswitch.ClientInfo class. More...

	ClientInfo (String userId, String deviceId, String idValue)
	Initializes a new instance of the fm.liveswitch.ClientInfo class. More...

	ClientInfo (String userId, String userAlias, String deviceId, String deviceAlias, String idValue, String tag, String[] roles, String protocol)
	Initializes a new instance of the fm.liveswitch.ClientInfo class. More...

	ClientInfo (String userId, String userAlias, String deviceId, String deviceAlias, String idValue, String tag, String[] roles, String protocol, String region)
	Initializes a new instance of the fm.liveswitch.ClientInfo class. More...

String	getApplicationId ()
	Gets the application identifier. More...

String	getArchitecture ()
	Gets the client architecture. More...

int	getCoreCount ()
	Gets the client core count. More...

String	getDeviceAlias ()
	Gets the device alias. More...

String	getDeviceId ()
	Gets the device identifier. More...

String	getExternalId ()
	Gets the client external identifier. More...

boolean	getIsSip ()
	Gets whether the client is connected via SIP. More...

String	getMachineName ()
	Gets the client machine name. More...

String	getOperatingSystem ()
	Gets the client operating system. More...

String	getOperatingSystemVersion ()
	Gets the client operating system version. More...

long	getPhysicalMemory ()
	Gets the connector physical memory. More...

String	getProtocol ()
	Gets the client protocol. More...

String	getRegion ()
	Gets the client region. More...

fm.liveswitch.ClientReport	getReport ()
	Gets the client report. More...

String[]	getRoles ()
	Gets the client roles. More...

String	getSourceLanguage ()
	Gets the client source language. More...

String	getTag ()
	Gets the client tag. More...

String	getUserAlias ()
	Gets the user alias. More...

String	getUserId ()
	Gets the user identifier. More...

String	getVersion ()
	Gets the client version. More...

boolean	isEquivalent (fm.liveswitch.ClientInfo clientInfo)
	Tests for equivalency. More...

boolean	isEquivalent (fm.liveswitch.ConnectionInfo connectionInfo)
	Tests for equivalency. More...

boolean	isEquivalent (String userId, String deviceId, String idValue)
	Tests equivalency. More...

void	setApplicationId (String value)
	Sets the application identifier. More...

void	setArchitecture (String value)
	Sets the client architecture. More...

void	setCoreCount (int value)
	Sets the client core count. More...

void	setDeviceAlias (String value)
	Sets the device alias. More...

void	setDeviceId (String value)
	Sets the device identifier. More...

void	setExternalId (String value)
	Sets the client external identifier. More...

void	setMachineName (String value)
	Sets the client machine name. More...

void	setOperatingSystem (String value)
	Sets the client operating system. More...

void	setOperatingSystemVersion (String value)
	Sets the client operating system version. More...

void	setPhysicalMemory (long value)
	Sets the connector physical memory. More...

void	setProtocol (String value)
	Sets the client protocol. More...

void	setRegion (String value)
	Sets the client region. More...

void	setReport (fm.liveswitch.ClientReport value)
	Sets the client report. More...

void	setRoles (String[] value)
	Sets the client roles. More...

void	setSourceLanguage (String value)
	Sets the client source language. More...

void	setTag (String value)
	Sets the client tag. More...

void	setUserAlias (String value)
	Sets the user alias. More...

void	setUserId (String value)
	Sets the user identifier. More...

void	setVersion (String value)
	Sets the client version. More...

String	toJson ()
	Serializes this instance to Json. More...

Public Member Functions inherited from fm.liveswitch.Info
String	getId ()
	Gets the identifier. More...

void	setId (String value)
	Sets the identifier. More...

Static Public Member Functions
static fm.liveswitch.ClientInfo	fromJson (String clientInfoJson)
	Deserializes an instance from JSON. More...

static fm.liveswitch.ClientInfo[]	fromJsonArray (String clientInfosJson)
	Deserializes an array of instances from JSON. More...

static String	getProtocolSip ()
	Gets the protocol string representing SIP. More...

static String	toJson (fm.liveswitch.ClientInfo clientInfo)
	Serializes an instance to JSON. More...

static String	toJsonArray (fm.liveswitch.ClientInfo[] clientInfos)
	Serializes an array of instances to JSON. More...

Static Public Member Functions inherited from fm.liveswitch.Info
static< T extends fm.liveswitch.IEquivalent< T > T[]	processArray (T[] newValues, T[] oldValues)
	Processes an array for an info. More...

static fm.liveswitch.NullableBoolean	processBoolean (boolean newValue, boolean oldValue)
	Processes a boolean for an info. More...

static boolean[]	processBooleanArray (boolean[] newValues, boolean[] oldValues)
	Processes a boolean array for an info. More...

static fm.liveswitch.NullableDouble	processDouble (double newValue, double oldValue)
	Processes a double for an info. More...

static fm.liveswitch.NullableFloat	processFloat (float newValue, float oldValue)
	Processes a float for an info. More...

static float[]	processFloatArray (float[] newValues, float[] oldValues)
	Processes a float array for an info. More...

static double[]	processFloatArray (double[] newValues, double[] oldValues)
	Processes a double array for an info. More...

static fm.liveswitch.NullableInteger	processInteger (int newValue, int oldValue)
	Processes an integer for an info. More...

static int[]	processIntegerArray (int[] newValues, int[] oldValues)
	Processes a integer array for an info. More...

static fm.liveswitch.NullableLong	processLong (long newValue, long oldValue)
	Processes a long for an info. More...

static long[]	processLongArray (long[] newValues, long[] oldValues)
	Processes a long array for an info. More...

static< T extends Object &fm.liveswitch.IEquivalent< T > T	processObject (T newValue, T oldValue)
	Processes an object for an info. More...

static fm.liveswitch.NullableShort	processShort (short newValue, short oldValue)
	Processes a short for an info. More...

static short[]	processShortArray (short[] newValues, short[] oldValues)
	Processes a short array for an info. More...

static String	processString (String newValue, String oldValue)
	Processes a string for an info. More...

Protected Member Functions
void	deserializeProperties (String key, String valueJson)
	Deserializes the properties. More...

void	serializeProperties (java.util.HashMap< String, String > jsonObject)
	Serializes the properties. More...

Protected Member Functions inherited from fm.liveswitch.Info
	Info ()

Detailed Description

Client information.

Constructor & Destructor Documentation

◆ ClientInfo() [1/4]

fm.liveswitch.ClientInfo.ClientInfo ( )

Initializes a new instance of the fm.liveswitch.ClientInfo class.

◆ ClientInfo() [2/4]

fm.liveswitch.ClientInfo.ClientInfo	(	String	userId,
		String	deviceId,
		String	idValue
	)

Initializes a new instance of the fm.liveswitch.ClientInfo class.

Parameters

userId	The user identifier.
deviceId	The device identifier.
idValue	The client identifier.

◆ ClientInfo() [3/4]

fm.liveswitch.ClientInfo.ClientInfo	(	String	userId,
		String	userAlias,
		String	deviceId,
		String	deviceAlias,
		String	idValue,
		String	tag,
		String[]	roles,
		String	protocol
	)

Initializes a new instance of the fm.liveswitch.ClientInfo class.

Parameters

userId	The user identifier.
userAlias	The user alias.
deviceId	The device identifier.
deviceAlias	The device alias.
idValue	The client identifier.
tag	The client tag.
roles	The client roles.
protocol	The client protocol.

◆ ClientInfo() [4/4]

fm.liveswitch.ClientInfo.ClientInfo	(	String	userId,
		String	userAlias,
		String	deviceId,
		String	deviceAlias,
		String	idValue,
		String	tag,
		String[]	roles,
		String	protocol,
		String	region
	)

Initializes a new instance of the fm.liveswitch.ClientInfo class.

Parameters

userId	The user identifier.
userAlias	The user alias.
deviceId	The device identifier.
deviceAlias	The device alias.
idValue	The client identifier.
tag	The client tag.
roles	The client roles.
protocol	The client protocol.
region	The client region.

Member Function Documentation

◆ deserializeProperties()

void fm.liveswitch.ClientInfo.deserializeProperties	(	String	key,
		String	valueJson
	)

protected

Deserializes the properties.

Parameters

key	The key.
valueJson	The value in JSON format.

Reimplemented from fm.liveswitch.Info.

◆ fromJson()

static fm.liveswitch.ClientInfo fm.liveswitch.ClientInfo.fromJson ( String clientInfoJson )

static

Deserializes an instance from JSON.

Parameters

clientInfoJson The JSON to deserialize.

Returns: The deserialized client info.

◆ fromJsonArray()

static fm.liveswitch.ClientInfo [] fm.liveswitch.ClientInfo.fromJsonArray ( String clientInfosJson )

static

Deserializes an array of instances from JSON.

Parameters

clientInfosJson The JSON to deserialize.

Returns: The deserialized client infos.

◆ getApplicationId()

String fm.liveswitch.ClientInfo.getApplicationId ( )

Gets the application identifier.

◆ getArchitecture()

String fm.liveswitch.ClientInfo.getArchitecture ( )

Gets the client architecture.

◆ getCoreCount()

int fm.liveswitch.ClientInfo.getCoreCount ( )

Gets the client core count.

◆ getDeviceAlias()

String fm.liveswitch.ClientInfo.getDeviceAlias ( )

Gets the device alias.

◆ getDeviceId()

String fm.liveswitch.ClientInfo.getDeviceId ( )

Gets the device identifier.

◆ getExternalId()

String fm.liveswitch.ClientInfo.getExternalId ( )

Gets the client external identifier.

◆ getIsSip()

boolean fm.liveswitch.ClientInfo.getIsSip ( )

Gets whether the client is connected via SIP.

◆ getMachineName()

String fm.liveswitch.ClientInfo.getMachineName ( )

Gets the client machine name.

◆ getOperatingSystem()

String fm.liveswitch.ClientInfo.getOperatingSystem ( )

Gets the client operating system.

◆ getOperatingSystemVersion()

String fm.liveswitch.ClientInfo.getOperatingSystemVersion ( )

Gets the client operating system version.

◆ getPhysicalMemory()

long fm.liveswitch.ClientInfo.getPhysicalMemory ( )

Gets the connector physical memory.

◆ getProtocol()

String fm.liveswitch.ClientInfo.getProtocol ( )

Gets the client protocol.

◆ getProtocolSip()

static String fm.liveswitch.ClientInfo.getProtocolSip ( )

static

Gets the protocol string representing SIP.

◆ getRegion()

String fm.liveswitch.ClientInfo.getRegion ( )

Gets the client region.

◆ getReport()

fm.liveswitch.ClientReport fm.liveswitch.ClientInfo.getReport ( )

Gets the client report.

◆ getRoles()

String [] fm.liveswitch.ClientInfo.getRoles ( )

Gets the client roles.

◆ getSourceLanguage()

String fm.liveswitch.ClientInfo.getSourceLanguage ( )

Gets the client source language.

◆ getTag()

String fm.liveswitch.ClientInfo.getTag ( )

Gets the client tag.

◆ getUserAlias()

String fm.liveswitch.ClientInfo.getUserAlias ( )

Gets the user alias.

◆ getUserId()

String fm.liveswitch.ClientInfo.getUserId ( )

Gets the user identifier.

◆ getVersion()

String fm.liveswitch.ClientInfo.getVersion ( )

Gets the client version.

◆ isEquivalent() [1/3]

boolean fm.liveswitch.ClientInfo.isEquivalent ( fm.liveswitch.ClientInfo clientInfo )

Tests for equivalency.

Parameters

clientInfo The client information.

Returns: true

if equivalent; otherwise,
false

.

◆ isEquivalent() [2/3]

boolean fm.liveswitch.ClientInfo.isEquivalent ( fm.liveswitch.ConnectionInfo connectionInfo )

Tests for equivalency.

Parameters

connectionInfo The connection information.

Returns: true

if equivalent; otherwise,
false

.

◆ isEquivalent() [3/3]

boolean fm.liveswitch.ClientInfo.isEquivalent	(	String	userId,
		String	deviceId,
		String	idValue
	)

Tests equivalency.

Parameters

userId	The user identifier.
deviceId	The device identifier.
idValue	The client identifier.

Returns: true

if equivalent; otherwise,
false

.

◆ serializeProperties()

void fm.liveswitch.ClientInfo.serializeProperties ( java.util.HashMap< String, String > jsonObject )

protected

Serializes the properties.

Parameters

jsonObject The JSON object.

Reimplemented from fm.liveswitch.Info.

◆ setApplicationId()

void fm.liveswitch.ClientInfo.setApplicationId ( String value )

Sets the application identifier.

◆ setArchitecture()

void fm.liveswitch.ClientInfo.setArchitecture ( String value )

Sets the client architecture.

◆ setCoreCount()

void fm.liveswitch.ClientInfo.setCoreCount ( int value )

Sets the client core count.

◆ setDeviceAlias()

void fm.liveswitch.ClientInfo.setDeviceAlias ( String value )

Sets the device alias.

◆ setDeviceId()

void fm.liveswitch.ClientInfo.setDeviceId ( String value )

Sets the device identifier.

◆ setExternalId()

void fm.liveswitch.ClientInfo.setExternalId ( String value )

Sets the client external identifier.

◆ setMachineName()

void fm.liveswitch.ClientInfo.setMachineName ( String value )

Sets the client machine name.

◆ setOperatingSystem()

void fm.liveswitch.ClientInfo.setOperatingSystem ( String value )

Sets the client operating system.

◆ setOperatingSystemVersion()

void fm.liveswitch.ClientInfo.setOperatingSystemVersion ( String value )

Sets the client operating system version.

◆ setPhysicalMemory()

void fm.liveswitch.ClientInfo.setPhysicalMemory ( long value )

Sets the connector physical memory.

◆ setProtocol()

void fm.liveswitch.ClientInfo.setProtocol ( String value )

Sets the client protocol.

◆ setRegion()

void fm.liveswitch.ClientInfo.setRegion ( String value )

Sets the client region.

◆ setReport()

void fm.liveswitch.ClientInfo.setReport ( fm.liveswitch.ClientReport value )

Sets the client report.

◆ setRoles()

void fm.liveswitch.ClientInfo.setRoles ( String[] value )

Sets the client roles.

◆ setSourceLanguage()

void fm.liveswitch.ClientInfo.setSourceLanguage ( String value )

Sets the client source language.

◆ setTag()

void fm.liveswitch.ClientInfo.setTag ( String value )

Sets the client tag.

◆ setUserAlias()

void fm.liveswitch.ClientInfo.setUserAlias ( String value )

Sets the user alias.

◆ setUserId()

void fm.liveswitch.ClientInfo.setUserId ( String value )

Sets the user identifier.

◆ setVersion()

void fm.liveswitch.ClientInfo.setVersion ( String value )

Sets the client version.

◆ toJson() [1/2]

String fm.liveswitch.ClientInfo.toJson ( )

Serializes this instance to Json.

◆ toJson() [2/2]

static String fm.liveswitch.ClientInfo.toJson ( fm.liveswitch.ClientInfo clientInfo )

static

Serializes an instance to JSON.

Parameters

clientInfo The client info to serialize.

Returns: The serialized JSON.

◆ toJsonArray()

static String fm.liveswitch.ClientInfo.toJsonArray ( fm.liveswitch.ClientInfo[] clientInfos )

static

Serializes an array of instances to JSON.

Parameters

clientInfos The client infos to serialize.

Returns: The serialized JSON.

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ ClientInfo() [1/4]

◆ ClientInfo() [2/4]

◆ ClientInfo() [3/4]

◆ ClientInfo() [4/4]

Member Function Documentation

◆ deserializeProperties()

◆ fromJson()

◆ fromJsonArray()

◆ getApplicationId()

◆ getArchitecture()

◆ getCoreCount()

◆ getDeviceAlias()

◆ getDeviceId()

◆ getExternalId()

◆ getIsSip()

◆ getMachineName()

◆ getOperatingSystem()

◆ getOperatingSystemVersion()

◆ getPhysicalMemory()

◆ getProtocol()

◆ getProtocolSip()

◆ getRegion()

◆ getReport()

◆ getRoles()

◆ getSourceLanguage()

◆ getTag()

◆ getUserAlias()

◆ getUserId()

◆ getVersion()

◆ isEquivalent() [1/3]

◆ isEquivalent() [2/3]

◆ isEquivalent() [3/3]

◆ serializeProperties()

◆ setApplicationId()

◆ setArchitecture()

◆ setCoreCount()

◆ setDeviceAlias()

◆ setDeviceId()

◆ setExternalId()

◆ setMachineName()

◆ setOperatingSystem()

◆ setOperatingSystemVersion()

◆ setPhysicalMemory()

◆ setProtocol()

◆ setRegion()

◆ setReport()

◆ setRoles()

◆ setSourceLanguage()

◆ setTag()

◆ setUserAlias()

◆ setUserId()

◆ setVersion()

◆ toJson() [1/2]

◆ toJson() [2/2]

◆ toJsonArray()