Search Results for

    / fm / liveswitch / Dynamic

    Class: Dynamic

    fm.liveswitch.Dynamic

    Supplies class instances with a key-value mapping to support dynamic property storage.

    Hierarchy

    • Serializable

      ↳ Dynamic

      ↳↳ Stream

      ↳↳ MediaTrack

      ↳↳ Connection

      ↳↳ DataChannel

      ↳↳ DomAudioSink

      ↳↳ LayoutPreset

      ↳↳ DomVideoSink

      ↳↳ Media

      ↳↳ PluginStream

      ↳↳ PluginMediaTrack

      ↳↳ PluginConnection

      ↳↳ PluginDataChannel

      ↳↳ PluginDomAudioSink

      ↳↳ PluginDomVideoSink

      ↳↳ PluginMedia

      ↳↳ WebRtcStreamBase

      ↳↳ WebRtcMediaTrackBase

      ↳↳ WebRtcConnectionBase

      ↳↳ WebRtcDataChannelBase

      ↳↳ WebRtcDomAudioSink

      ↳↳ WebRtcDomVideoSink

      ↳↳ WebRtcMediaBase

      ↳↳ HttpRequestArgs

      ↳↳ HttpWebRequestSender

      ↳↳ WebSocketCloseArgs

      ↳↳ WebSocketCloseCompleteArgs

      ↳↳ WebSocketOpenArgs

      ↳↳ WebSocketOpenFailureArgs

      ↳↳ WebSocketOpenSuccessArgs

      ↳↳ WebSocketReceiveArgs

      ↳↳ WebSocketSendArgs

      ↳↳ WebSocketStreamFailureArgs

      ↳↳ MediaBuffer

      ↳↳ MediaSinkBase

      ↳↳ MediaSourceBase

      ↳↳ Channel

      ↳↳ Client

      ↳↳ ManagedConnection

      ↳↳ Message

    Table of contents

    Constructors

    • constructor

    Methods

    • getDynamicProperties
    • getDynamicValue
    • getTypeString
    • setDynamicValue
    • unsetDynamicValue

    Constructors

    constructor

    + new Dynamic(): Dynamic

    Returns: Dynamic

    Inherited from: Serializable

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

    Methods

    getDynamicProperties

    ▸ getDynamicProperties(): Hash<string, Object>

    Gets all dynamic properties on this instance.

    Returns: Hash<string, Object>

    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.

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


    getTypeString

    ▸ getTypeString(): string

    Returns: string

    Overrides: Serializable

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


    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

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


    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.

    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.14.6