Search Results for

    / fm / liveswitch / CandidateInfo

    Class: CandidateInfo

    fm.liveswitch.CandidateInfo

    Candidate information.

    Hierarchy

    • Info

      ↳ CandidateInfo

    Table of contents

    Constructors

    • constructor

    Methods

    • deserializeProperties
    • getIPAddress
    • getId
    • getPort
    • getPriority
    • getProtocol
    • getRelatedIPAddress
    • getRelatedPort
    • getRelayProtocol
    • getType
    • getTypeString
    • serializeProperties
    • setIPAddress
    • setId
    • setPort
    • setPriority
    • setProtocol
    • setRelatedIPAddress
    • setRelatedPort
    • setRelayProtocol
    • setType
    • toJson
    • fromJson
    • fromJsonArray
    • processArray
    • processBoolean
    • processBooleanArray
    • processDouble
    • processFloat
    • processFloatArray
    • processInteger
    • processIntegerArray
    • processLong
    • processLongArray
    • processObject
    • processShort
    • processShortArray
    • processString
    • toJson
    • toJsonArray

    Constructors

    constructor

    + new CandidateInfo(): CandidateInfo

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

    Returns: CandidateInfo

    Inherited from: Info

    Defined in: Generated/TypeScript/fm.liveswitch/CandidateInfo.ts:28

    + new CandidateInfo(stats: CandidateStats, lastStats: CandidateStats): CandidateInfo

    Parameters:

    Name Type
    stats CandidateStats
    lastStats CandidateStats

    Returns: CandidateInfo

    Defined in: Generated/TypeScript/fm.liveswitch/CandidateInfo.ts:35

    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/CandidateInfo.ts:135


    getIPAddress

    ▸ getIPAddress(): string

    Gets the candidate IP address.

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/CandidateInfo.ts:175


    getId

    ▸ getId(): string

    Gets the identifier.

    Returns: string

    Inherited from: Info

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


    getPort

    ▸ getPort(): number

    Gets the candidate port.

    Returns: number

    Defined in: Generated/TypeScript/fm.liveswitch/CandidateInfo.ts:187


    getPriority

    ▸ getPriority(): number

    Gets the candidate priority.

    Returns: number

    Defined in: Generated/TypeScript/fm.liveswitch/CandidateInfo.ts:199


    getProtocol

    ▸ getProtocol(): string

    Gets the candidate protocol.

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/CandidateInfo.ts:211


    getRelatedIPAddress

    ▸ getRelatedIPAddress(): string

    Gets the candidate related IP address.

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/CandidateInfo.ts:223


    getRelatedPort

    ▸ getRelatedPort(): number

    Gets the candidate related port.

    Returns: number

    Defined in: Generated/TypeScript/fm.liveswitch/CandidateInfo.ts:235


    getRelayProtocol

    ▸ getRelayProtocol(): string

    Gets the candidate relay protocol.

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/CandidateInfo.ts:247


    getType

    ▸ getType(): string

    Gets the candidate type.

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/CandidateInfo.ts:259


    getTypeString

    ▸ getTypeString(): string

    Returns: string

    Overrides: Info

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


    setIPAddress

    ▸ setIPAddress(value: string): void

    Sets the candidate IP address.

    Parameters:

    Name Type
    value string

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/CandidateInfo.ts:308


    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


    setPort

    ▸ setPort(value: number): void

    Sets the candidate port.

    Parameters:

    Name Type
    value number

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/CandidateInfo.ts:320


    setPriority

    ▸ setPriority(value: number): void

    Sets the candidate priority.

    Parameters:

    Name Type
    value number

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/CandidateInfo.ts:332


    setProtocol

    ▸ setProtocol(value: string): void

    Sets the candidate protocol.

    Parameters:

    Name Type
    value string

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/CandidateInfo.ts:344


    setRelatedIPAddress

    ▸ setRelatedIPAddress(value: string): void

    Sets the candidate related IP address.

    Parameters:

    Name Type
    value string

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/CandidateInfo.ts:356


    setRelatedPort

    ▸ setRelatedPort(value: number): void

    Sets the candidate related port.

    Parameters:

    Name Type
    value number

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/CandidateInfo.ts:368


    setRelayProtocol

    ▸ setRelayProtocol(value: string): void

    Sets the candidate relay protocol.

    Parameters:

    Name Type
    value string

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/CandidateInfo.ts:380


    setType

    ▸ setType(value: string): void

    Sets the candidate type.

    Parameters:

    Name Type
    value string

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/CandidateInfo.ts:392


    toJson

    ▸ toJson(): string

    Serializes this instance to JSON.

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/CandidateInfo.ts:404


    fromJson

    ▸ StaticfromJson(candidateReportJson: string): CandidateInfo

    Deserializes an instance from JSON.

    Parameters:

    Name Type Description
    candidateReportJson string The JSON.

    Returns: CandidateInfo

    The deserialized instance.

    Defined in: Generated/TypeScript/fm.liveswitch/CandidateInfo.ts:69


    fromJsonArray

    ▸ StaticfromJsonArray(candidateReportsJson: string): CandidateInfo[]

    Deserializes an array from JSON.

    Parameters:

    Name Type Description
    candidateReportsJson string The JSON.

    Returns: CandidateInfo[]

    The deserialized array.

    Defined in: Generated/TypeScript/fm.liveswitch/CandidateInfo.ts:87


    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(candidateReport: CandidateInfo): string

    Serializes an instance to JSON.

    Parameters:

    Name Type Description
    candidateReport CandidateInfo The instance.

    Returns: string

    The serialized JSON.

    Defined in: Generated/TypeScript/fm.liveswitch/CandidateInfo.ts:105


    toJsonArray

    ▸ StatictoJsonArray(candidateReports: CandidateInfo[]): string

    Serializes an array to JSON.

    Parameters:

    Name Type Description
    candidateReports CandidateInfo[] The array.

    Returns: string

    The serialized JSON.

    Defined in: Generated/TypeScript/fm.liveswitch/CandidateInfo.ts:121

    In This Article
    Back to top Copyright © LiveSwitch Inc. All Rights Reserved. Doc build for LiveSwitch v1.15.0