Search Results for

    / fm / liveswitch / WebSocketOpenSuccessArgs

    Class: WebSocketOpenSuccessArgs

    fm.liveswitch.WebSocketOpenSuccessArgs

    Arguments for [[fm.liveswitch.webSocketOpenArgs.onSuccess]].

    Hierarchy

    • Dynamic

      ↳ WebSocketOpenSuccessArgs

    Table of contents

    Constructors

    • constructor

    Methods

    • getDynamicProperties
    • getDynamicValue
    • getOpenArgs
    • getTypeString
    • setDynamicValue
    • setOpenArgs
    • unsetDynamicValue

    Constructors

    constructor

    + new WebSocketOpenSuccessArgs(): WebSocketOpenSuccessArgs

    Returns: WebSocketOpenSuccessArgs

    Inherited from: Dynamic

    Defined in: Generated/TypeScript/fm.liveswitch/WebSocketOpenSuccessArgs.ts:14

    Methods

    getDynamicProperties

    ▸ getDynamicProperties(): Hash<string, Object>

    Gets all dynamic properties on this instance.

    Returns: Hash<string, Object>

    Inherited from: Dynamic

    Defined in: Generated/TypeScript/fm.liveswitch/Dynamic.ts:37


    getDynamicValue

    ▸ getDynamicValue(key: string): Object

    Gets a property value from the local cache.

    Parameters:

    Name Type Description
    key string The property key. This key is used internally only, but should be namespaced to avoid conflict with third-party extensions.

    Returns: Object

    The stored value, if found; otherwise null.

    Inherited from: Dynamic

    Defined in: Generated/TypeScript/fm.liveswitch/Dynamic.ts:58


    getOpenArgs

    ▸ getOpenArgs(): WebSocketOpenArgs

    Gets the original arguments passed to the open method.

    Returns: WebSocketOpenArgs

    Defined in: Generated/TypeScript/fm.liveswitch/WebSocketOpenSuccessArgs.ts:32


    getTypeString

    ▸ getTypeString(): string

    Returns: string

    Overrides: Dynamic

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


    setDynamicValue

    ▸ setDynamicValue(key: string, value: Object): void

    Sets a property value in the local cache.

    Parameters:

    Name Type Description
    key string The property key. This key is used internally only, but should be namespaced to avoid conflict with third-party extensions.
    value Object The property value. This can be any object that needs to be stored for future use.

    Returns: void

    Inherited from: Dynamic

    Defined in: Generated/TypeScript/fm.liveswitch/Dynamic.ts:95


    setOpenArgs

    ▸ setOpenArgs(value: WebSocketOpenArgs): void

    Sets the original arguments passed to the open method.

    Parameters:

    Name Type
    value WebSocketOpenArgs

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/WebSocketOpenSuccessArgs.ts:44


    unsetDynamicValue

    ▸ unsetDynamicValue(key: string): boolean

    Removes a property value from the local cache. Returns true if the value was removed and returns false otherwise.

    Parameters:

    Name Type Description
    key string The property key. This key is used internally only, but should be namespaced to avoid conflict with third-party extensions.

    Returns: boolean

    true if the value was removed; otherwise, false.

    Inherited from: Dynamic

    Defined in: Generated/TypeScript/fm.liveswitch/Dynamic.ts:122

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