/ fm / liveswitch / CandidatePairReport

Class: CandidatePairReport

fm.liveswitch.CandidatePairReport

Candidate pair report.

Hierarchy

• Report

  ↳ CandidatePairReport

Table of contents

Constructors

• constructor

Methods

• deserializeProperties
• getBytesReceived
• getBytesSent
• getConsentRequestsReceived
• getConsentRequestsSent
• getConsentResponsesReceived
• getConsentResponsesSent
• getCurrentRoundTripTime
• getRequestsReceived
• getRequestsSent
• getResponsesReceived
• getResponsesSent
• getTotalRoundTripTime
• getTypeString
• serializeProperties
• setBytesReceived
• setBytesSent
• setConsentRequestsReceived
• setConsentRequestsSent
• setConsentResponsesReceived
• setConsentResponsesSent
• setCurrentRoundTripTime
• setRequestsReceived
• setRequestsSent
• setResponsesReceived
• setResponsesSent
• setTotalRoundTripTime
• toJson
• fromJson
• fromJsonArray
• processArray
• processBoolean
• processBooleanArray
• processDouble
• processFloat
• processFloatArray
• processInteger
• processIntegerArray
• processLong
• processLongArray
• processObject
• processShort
• processShortArray
• processString
• toJson
• toJsonArray

Constructors

constructor

+ new CandidatePairReport(): CandidatePairReport

Initializes a new instance of the [[fm.liveswitch.candidatePairReport]] class.

Returns: CandidatePairReport

Inherited from: Report

Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairReport.ts:36

+ new CandidatePairReport(stats: CandidatePairStats, lastStats: CandidatePairStats): CandidatePairReport

Parameters:

Name	Type
stats	CandidatePairStats
lastStats	CandidatePairStats

Returns: CandidatePairReport

Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairReport.ts:43

Methods

deserializeProperties

▸ ProtecteddeserializeProperties(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: Report

Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairReport.ts:146

---

getBytesReceived

▸ getBytesReceived(): number

Gets the number of candidate pair bytes received.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairReport.ts:198

---

getBytesSent

▸ getBytesSent(): number

Gets the number of candidate pair bytes sent.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairReport.ts:210

---

getConsentRequestsReceived

▸ getConsentRequestsReceived(): number

Gets the number of candidate pair consent requests received.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairReport.ts:222

---

getConsentRequestsSent

▸ getConsentRequestsSent(): number

Gets the number of candidate pair consent requests sent.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairReport.ts:234

---

getConsentResponsesReceived

▸ getConsentResponsesReceived(): number

Gets the number of candidate pair consent responses received.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairReport.ts:246

---

getConsentResponsesSent

▸ getConsentResponsesSent(): number

Gets the number of candidate pair consent responses sent.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairReport.ts:258

---

getCurrentRoundTripTime

▸ getCurrentRoundTripTime(): number

Gets the candidate pair current round trip time in milliseconds.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairReport.ts:270

---

getRequestsReceived

▸ getRequestsReceived(): number

Gets the number of candidate pair requests received.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairReport.ts:282

---

getRequestsSent

▸ getRequestsSent(): number

Gets the number of candidate pair requests sent.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairReport.ts:294

---

getResponsesReceived

▸ getResponsesReceived(): number

Gets the number of candidate pair responses received.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairReport.ts:306

---

getResponsesSent

▸ getResponsesSent(): number

Gets the number of candidate pair responses sent.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairReport.ts:318

---

getTotalRoundTripTime

▸ getTotalRoundTripTime(): number

Gets the candidate pair total round trip time in milliseconds.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairReport.ts:330

---

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: Report

Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairReport.ts:10

---

serializeProperties

▸ ProtectedserializeProperties(jsonObject: Hash<string, string>): void

Serializes the properties.

Parameters:

Name	Type	Description
jsonObject	Hash<string, string>	The JSON object.

Returns: void

Overrides: Report

Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairReport.ts:343

---

setBytesReceived

▸ setBytesReceived(value: number): void

Sets the number of candidate pair bytes received.

Parameters:

Name	Type
value	number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairReport.ts:391

---

setBytesSent

▸ setBytesSent(value: number): void

Sets the number of candidate pair bytes sent.

Parameters:

Name	Type
value	number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairReport.ts:403

---

setConsentRequestsReceived

▸ setConsentRequestsReceived(value: number): void

Sets the number of candidate pair consent requests received.

Parameters:

Name	Type
value	number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairReport.ts:415

---

setConsentRequestsSent

▸ setConsentRequestsSent(value: number): void

Sets the number of candidate pair consent requests sent.

Parameters:

Name	Type
value	number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairReport.ts:427

---

setConsentResponsesReceived

▸ setConsentResponsesReceived(value: number): void

Sets the number of candidate pair consent responses received.

Parameters:

Name	Type
value	number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairReport.ts:439

---

setConsentResponsesSent

▸ setConsentResponsesSent(value: number): void

Sets the number of candidate pair consent responses sent.

Parameters:

Name	Type
value	number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairReport.ts:451

---

setCurrentRoundTripTime

▸ setCurrentRoundTripTime(value: number): void

Sets the candidate pair current round trip time in milliseconds.

Parameters:

Name	Type
value	number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairReport.ts:463

---

setRequestsReceived

▸ setRequestsReceived(value: number): void

Sets the number of candidate pair requests received.

Parameters:

Name	Type
value	number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairReport.ts:475

---

setRequestsSent

▸ setRequestsSent(value: number): void

Sets the number of candidate pair requests sent.

Parameters:

Name	Type
value	number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairReport.ts:487

---

setResponsesReceived

▸ setResponsesReceived(value: number): void

Sets the number of candidate pair responses received.

Parameters:

Name	Type
value	number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairReport.ts:499

---

setResponsesSent

▸ setResponsesSent(value: number): void

Sets the number of candidate pair responses sent.

Parameters:

Name	Type
value	number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairReport.ts:511

---

setTotalRoundTripTime

▸ setTotalRoundTripTime(value: number): void

Sets the candidate pair total round trip time in milliseconds.

Parameters:

Name	Type
value	number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairReport.ts:523

---

toJson

▸ toJson(): string

Serializes this instance to JSON.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairReport.ts:535

---

fromJson

▸ StaticfromJson(instanceJson: string): CandidatePairReport

Deserializes an instance from JSON.

Parameters:

Name	Type	Description
instanceJson	string	The instance JSON.

Returns: CandidatePairReport

The deserialized instance.

Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairReport.ts:80

---

fromJsonArray

▸ StaticfromJsonArray(arrayJson: string): CandidatePairReport[]

Derializes an array from JSON.

Parameters:

Name	Type	Description
arrayJson	string	The array JSON.

Returns: CandidatePairReport[]

The deserialized array.

Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairReport.ts:98

---

processArray

▸ StaticprocessArray<T>(newValues: T[], oldValues: T[]): T[]

Processes an array for a report.

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: Report

Defined in: Generated/TypeScript/fm.liveswitch/Report.ts:31

---

processBoolean

▸ StaticprocessBoolean(newValue: boolean, oldValue: boolean): boolean

Processes a boolean for a report.

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: Report

Defined in: Generated/TypeScript/fm.liveswitch/Report.ts:57

---

processBooleanArray

▸ StaticprocessBooleanArray(newValues: boolean[], oldValues: boolean[]): boolean[]

Processes a boolean array for a report.

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: Report

Defined in: Generated/TypeScript/fm.liveswitch/Report.ts:72

---

processDouble

▸ StaticprocessDouble(newValue: number, oldValue: number): number

Processes a double for a report.

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: Report

Defined in: Generated/TypeScript/fm.liveswitch/Report.ts:98

---

processFloat

▸ StaticprocessFloat(newValue: number, oldValue: number): number

Processes a float for a report.

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: Report

Defined in: Generated/TypeScript/fm.liveswitch/Report.ts:113

---

processFloatArray

▸ StaticprocessFloatArray(newValues: number[], oldValues: number[]): number[]

Processes a float array for a report.

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: Report

Defined in: Generated/TypeScript/fm.liveswitch/Report.ts:128

---

processInteger

▸ StaticprocessInteger(newValue: number, oldValue: number): number

Processes an integer for a report.

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: Report

Defined in: Generated/TypeScript/fm.liveswitch/Report.ts:154

---

processIntegerArray

▸ StaticprocessIntegerArray(newValues: number[], oldValues: number[]): number[]

Processes a integer array for a report.

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: Report

Defined in: Generated/TypeScript/fm.liveswitch/Report.ts:171

---

processLong

▸ StaticprocessLong(newValue: number, oldValue: number): number

Processes a long for a report.

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: Report

Defined in: Generated/TypeScript/fm.liveswitch/Report.ts:197

---

processLongArray

▸ StaticprocessLongArray(newValues: number[], oldValues: number[]): number[]

Processes a long array for a report.

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: Report

Defined in: Generated/TypeScript/fm.liveswitch/Report.ts:214

---

processObject

▸ StaticprocessObject<T>(newValue: T, oldValue: T): T

Processes an array for a report.

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: Report

Defined in: Generated/TypeScript/fm.liveswitch/Report.ts:240

---

processShort

▸ StaticprocessShort(newValue: number, oldValue: number): number

Processes a short for a report.

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: Report

Defined in: Generated/TypeScript/fm.liveswitch/Report.ts:261

---

processShortArray

▸ StaticprocessShortArray(newValues: number[], oldValues: number[]): number[]

Processes a short array for a report.

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: Report

Defined in: Generated/TypeScript/fm.liveswitch/Report.ts:278

---

processString

▸ StaticprocessString(newValue: string, oldValue: string): string

Processes a string for a report.

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: Report

Defined in: Generated/TypeScript/fm.liveswitch/Report.ts:304

---

toJson

▸ StatictoJson(instance: CandidatePairReport): string

Serializes an instance to JSON.

Parameters:

Name	Type	Description
instance	CandidatePairReport	The instance.

Returns: string

The serialized instance JSON.

Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairReport.ts:116

---

toJsonArray

▸ StatictoJsonArray(array: CandidatePairReport[]): string

Serializes an array to JSON.

Parameters:

Name	Type	Description
array	CandidatePairReport[]	The array.

Returns: string

The serialized array JSON.

Defined in: Generated/TypeScript/fm.liveswitch/CandidatePairReport.ts:132