Search Results for

    / fm / liveswitch / MessageInfo

    Class: MessageInfo

    fm.liveswitch.MessageInfo

    Message information.

    Hierarchy

    • Info

      ↳ MessageInfo

    Table of contents

    Constructors

    • constructor

    Methods

    • deserializeProperties
    • getChannelId
    • getClientId
    • getDeviceId
    • getId
    • getPayload
    • getTypeString
    • getUserId
    • serializeProperties
    • setChannelId
    • setClientId
    • setDeviceId
    • setId
    • setPayload
    • setUserId
    • toJson
    • fromJson
    • processArray
    • processBoolean
    • processBooleanArray
    • processDouble
    • processFloat
    • processFloatArray
    • processInteger
    • processIntegerArray
    • processLong
    • processLongArray
    • processObject
    • processShort
    • processShortArray
    • processString
    • toJson

    Constructors

    constructor

    + new MessageInfo(): MessageInfo

    Returns: MessageInfo

    Inherited from: Info

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

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


    getChannelId

    ▸ getChannelId(): string

    Gets the channel identifier.

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/MessageInfo.ts:106


    getClientId

    ▸ getClientId(): string

    Gets the client identifier.

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/MessageInfo.ts:118


    getDeviceId

    ▸ getDeviceId(): string

    Gets the device identifier.

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/MessageInfo.ts:130


    getId

    ▸ getId(): string

    Gets the identifier.

    Returns: string

    Inherited from: Info

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


    getPayload

    ▸ getPayload(): string

    Gets the message.

    Returns: string

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


    getTypeString

    ▸ getTypeString(): string

    Returns: string

    Overrides: Info

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


    getUserId

    ▸ getUserId(): string

    Gets the user identifier.

    Returns: string

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


    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/MessageInfo.ts:167


    setChannelId

    ▸ setChannelId(value: string): void

    Sets the channel identifier.

    Parameters:

    Name Type
    value string

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/MessageInfo.ts:194


    setClientId

    ▸ setClientId(value: string): void

    Sets the client identifier.

    Parameters:

    Name Type
    value string

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/MessageInfo.ts:206


    setDeviceId

    ▸ setDeviceId(value: string): void

    Sets the device identifier.

    Parameters:

    Name Type
    value string

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/MessageInfo.ts:218


    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


    setPayload

    ▸ setPayload(value: string): void

    Sets the message.

    Parameters:

    Name Type
    value string

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/MessageInfo.ts:230


    setUserId

    ▸ setUserId(value: string): void

    Sets the user identifier.

    Parameters:

    Name Type
    value string

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/MessageInfo.ts:242


    toJson

    ▸ toJson(): string

    Serializes this instance to JSON.

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/MessageInfo.ts:254


    fromJson

    ▸ StaticfromJson(messageInfoJson: string): MessageInfo

    Deserializes an instance from JSON.

    Parameters:

    Name Type
    messageInfoJson string

    Returns: MessageInfo

    Defined in: Generated/TypeScript/fm.liveswitch/MessageInfo.ts:40


    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(messageInfo: MessageInfo): string

    Serializes an instance to JSON.

    Parameters:

    Name Type
    messageInfo MessageInfo

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/MessageInfo.ts:56

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