/ fm / liveswitch / DataChannelInfo

Class: DataChannelInfo

fm.liveswitch.DataChannelInfo

Data channel information.

Hierarchy

• Info

  ↳ DataChannelInfo

Table of contents

Constructors

• constructor

Methods

• deserializeProperties
• fmliveswitchDataChannelInfoInit
• getId
• getLabel
• getOrdered
• getReport
• getState
• getSubprotocol
• getTypeString
• serializeProperties
• setId
• setLabel
• setOrdered
• setReport
• setState
• setSubprotocol
• toJson
• fromJson
• fromJsonArray
• processArray
• processBoolean
• processBooleanArray
• processDouble
• processFloat
• processFloatArray
• processInteger
• processIntegerArray
• processLong
• processLongArray
• processObject
• processShort
• processShortArray
• processString
• toJson
• toJsonArray

Constructors

constructor

+ new DataChannelInfo(): DataChannelInfo

Returns: DataChannelInfo

Inherited from: Info

Defined in: Generated/TypeScript/fm.liveswitch/DataChannelInfo.ts:27

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

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

---

fmliveswitchDataChannelInfoInit

▸ PrivatefmliveswitchDataChannelInfoInit(): void

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/DataChannelInfo.ts:24

---

getId

▸ getId(): string

Gets the identifier.

Returns: string

Inherited from: Info

Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:336

---

getLabel

▸ getLabel(): string

Gets the data channel label.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/DataChannelInfo.ts:147

---

getOrdered

▸ getOrdered(): boolean

Gets whether the data channel is ordered.

Returns: boolean

Defined in: Generated/TypeScript/fm.liveswitch/DataChannelInfo.ts:159

---

getReport

▸ getReport(): DataChannelReport

Gets the data channel report.

Returns: DataChannelReport

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

---

getState

▸ getState(): string

Gets the data channel state.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/DataChannelInfo.ts:183

---

getSubprotocol

▸ getSubprotocol(): string

Gets the data channel subprotocol.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/DataChannelInfo.ts:195

---

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: Info

Defined in: Generated/TypeScript/fm.liveswitch/DataChannelInfo.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: Info

Defined in: Generated/TypeScript/fm.liveswitch/DataChannelInfo.ts:216

---

setId

▸ setId(value: string): void

Sets the identifier.

Parameters:

Name	Type
value	string

Returns: void

Inherited from: Info

Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:363

---

setLabel

▸ setLabel(value: string): void

Sets the data channel label.

Parameters:

Name	Type
value	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/DataChannelInfo.ts:243

---

setOrdered

▸ setOrdered(value: boolean): void

Sets whether the data channel is ordered.

Parameters:

Name	Type
value	boolean

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/DataChannelInfo.ts:255

---

setReport

▸ setReport(value: DataChannelReport): void

Sets the data channel report.

Parameters:

Name	Type
value	DataChannelReport

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/DataChannelInfo.ts:267

---

setState

▸ setState(value: string): void

Sets the data channel state.

Parameters:

Name	Type
value	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/DataChannelInfo.ts:279

---

setSubprotocol

▸ setSubprotocol(value: string): void

Sets the data channel subprotocol.

Parameters:

Name	Type
value	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/DataChannelInfo.ts:291

---

toJson

▸ toJson(): string

Serializes this instance to Json.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/DataChannelInfo.ts:303

---

fromJson

▸ StaticfromJson(dataChannelInfoJson: string): DataChannelInfo

Deserializes Json to a DataChannelInfo.

Parameters:

Name	Type	Description
dataChannelInfoJson	string	The serialized Json.

Returns: DataChannelInfo

The deserialized DataChannelInfo.

Defined in: Generated/TypeScript/fm.liveswitch/DataChannelInfo.ts:47

---

fromJsonArray

▸ StaticfromJsonArray(dataChannelInfosJson: string): DataChannelInfo[]

Deserializes JSON to an array.

Parameters:

Name	Type	Description
dataChannelInfosJson	string	The serialized JSON.

Returns: DataChannelInfo[]

The deserialized array.

Defined in: Generated/TypeScript/fm.liveswitch/DataChannelInfo.ts:65

---

processArray

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

Processes an array for an info.

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

Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:34

---

processBoolean

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

Processes a boolean for an info.

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

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

---

processBooleanArray

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

Processes a boolean array for an info.

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

Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:75

---

processDouble

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

Processes a double for an info.

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

Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:101

---

processFloat

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

Processes a float for an info.

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

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

---

processFloatArray

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

Processes a float array for an info.

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

Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:131

---

processInteger

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

Processes an integer for an info.

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

Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:157

---

processIntegerArray

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

Processes a integer array for an info.

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

Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:174

---

processLong

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

Processes a long for an info.

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

Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:200

---

processLongArray

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

Processes a long array for an info.

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

Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:217

---

processObject

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

Processes an object for an info.

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

Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:243

---

processShort

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

Processes a short for an info.

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

Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:264

---

processShortArray

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

Processes a short array for an info.

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

Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:281

---

processString

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

Processes a string for an info.

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

Defined in: Generated/TypeScript/fm.liveswitch/Info.ts:307

---

toJson

▸ StatictoJson(dataChannelInfo: DataChannelInfo): string

Serializes an instance to Json.

Parameters:

Name	Type	Description
dataChannelInfo	DataChannelInfo	The instance to serialize.

Returns: string

Serialized Json.

Defined in: Generated/TypeScript/fm.liveswitch/DataChannelInfo.ts:83

---

toJsonArray

▸ StatictoJsonArray(dataChannelInfos: DataChannelInfo[]): string

Serializes an array to JSON.

Parameters:

Name	Type	Description
dataChannelInfos	DataChannelInfo[]	The array to serialize.

Returns: string

The serialized JSON.

Defined in: Generated/TypeScript/fm.liveswitch/DataChannelInfo.ts:99