/ fm / liveswitch / ChannelReport

Class: ChannelReport

fm.liveswitch.ChannelReport

Channel report.

Hierarchy

• Report

  ↳ ChannelReport

Table of contents

Constructors

• constructor

Methods

• deserializeProperties
• getId
• getMessageBytesReceived
• getMessageBytesSent
• getMessagesReceived
• getMessagesSent
• getTypeString
• serializeProperties
• setId
• setMessageBytesReceived
• setMessageBytesSent
• setMessagesReceived
• setMessagesSent
• toJson
• fromJson
• fromJsonArray
• processArray
• processBoolean
• processBooleanArray
• processDouble
• processFloat
• processFloatArray
• processInteger
• processIntegerArray
• processLong
• processLongArray
• processObject
• processShort
• processShortArray
• processString
• toJson
• toJsonArray

Constructors

constructor

+ new ChannelReport(): ChannelReport

Returns: ChannelReport

Inherited from: Report

Defined in: Generated/TypeScript/fm.liveswitch/ChannelReport.ts:22

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/ChannelReport.ts:108

---

getId

▸ getId(): string

Gets the identifier.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/ChannelReport.ts:142

---

getMessageBytesReceived

▸ getMessageBytesReceived(): number

Gets the number of message bytes received on this channel.

Returns: number

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

---

getMessageBytesSent

▸ getMessageBytesSent(): number

Gets the number of message bytes sent on this channel.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/ChannelReport.ts:166

---

getMessagesReceived

▸ getMessagesReceived(): number

Gets the number of messages received on this channel.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/ChannelReport.ts:178

---

getMessagesSent

▸ getMessagesSent(): number

Gets the number of messages sent on this channel.

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/ChannelReport.ts:190

---

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: Report

Defined in: Generated/TypeScript/fm.liveswitch/ChannelReport.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/ChannelReport.ts:211

---

setId

▸ setId(value: string): void

Sets the identifier.

Parameters:

Name	Type
value	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ChannelReport.ts:238

---

setMessageBytesReceived

▸ setMessageBytesReceived(value: number): void

Sets the number of message bytes received on this channel.

Parameters:

Name	Type
value	number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ChannelReport.ts:250

---

setMessageBytesSent

▸ setMessageBytesSent(value: number): void

Sets the number of message bytes sent on this channel.

Parameters:

Name	Type
value	number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ChannelReport.ts:262

---

setMessagesReceived

▸ setMessagesReceived(value: number): void

Sets the number of messages received on this channel.

Parameters:

Name	Type
value	number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ChannelReport.ts:274

---

setMessagesSent

▸ setMessagesSent(value: number): void

Sets the number of messages sent on this channel.

Parameters:

Name	Type
value	number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/ChannelReport.ts:286

---

toJson

▸ toJson(): string

Serializes this instance to Json.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/ChannelReport.ts:298

---

fromJson

▸ StaticfromJson(instanceJson: string): ChannelReport

Deserializes an instance from JSON.

Parameters:

Name	Type	Description
instanceJson	string	The instance JSON.

Returns: ChannelReport

The deserialized instance.

Defined in: Generated/TypeScript/fm.liveswitch/ChannelReport.ts:42

---

fromJsonArray

▸ StaticfromJsonArray(arrayJson: string): ChannelReport[]

Derializes an array from JSON.

Parameters:

Name	Type	Description
arrayJson	string	The array JSON.

Returns: ChannelReport[]

The deserialized array.

Defined in: Generated/TypeScript/fm.liveswitch/ChannelReport.ts:60

---

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: ChannelReport): string

Serializes an instance to JSON.

Parameters:

Name	Type	Description
instance	ChannelReport	The instance to serialize.

Returns: string

The instance JSON.

Defined in: Generated/TypeScript/fm.liveswitch/ChannelReport.ts:78

---

toJsonArray

▸ StatictoJsonArray(array: ChannelReport[]): string

Serializes an array to JSON.

Parameters:

Name	Type	Description
array	ChannelReport[]	The array.

Returns: string

The serialized array JSON.

Defined in: Generated/TypeScript/fm.liveswitch/ChannelReport.ts:94