Search Results for

    / fm / liveswitch / Client

    Class: Client

    fm.liveswitch.Client

    A LiveSwitch client.

    Hierarchy

    • Dynamic

      ↳ Client

    Table of contents

    Constructors

    • constructor

    Methods

    • addOnApplicationMessage
    • addOnDeviceMessage
    • addOnHttpRequestCreated
    • addOnHttpResponseReceived
    • addOnMessage
    • addOnRemoteUpdate
    • addOnStateChange
    • addOnUserMessage
    • closeAll
    • fmliveswitchClientInit
    • getApplicationId
    • getAutoUnregister
    • getChannels
    • getConfig
    • getDeviceAlias
    • getDeviceId
    • getDisableCors
    • getDisableJsonp
    • getDisablePostMessage
    • getDisableWebSockets
    • getDynamicProperties
    • getDynamicValue
    • getExternalId
    • getForceJsonp
    • getGatewayUrl
    • getId
    • getInfo
    • getMessageBytesReceived
    • getMessageBytesSent
    • getMessagesReceived
    • getMessagesSent
    • getRegion
    • getRequestMaxRetries
    • getRequestTimeout
    • getRoles
    • getState
    • getTag
    • getTypeString
    • getUnregisterException
    • getUserAlias
    • getUserId
    • join
    • leave
    • register
    • removeOnApplicationMessage
    • removeOnDeviceMessage
    • removeOnHttpRequestCreated
    • removeOnHttpResponseReceived
    • removeOnMessage
    • removeOnRemoteUpdate
    • removeOnStateChange
    • removeOnUserMessage
    • sendMessage
    • setAutoUnregister
    • setDeviceAlias
    • setDisableCors
    • setDisableJsonp
    • setDisablePostMessage
    • setDisableWebSockets
    • setDynamicValue
    • setExternalId
    • setForceJsonp
    • setRequestMaxRetries
    • setRequestTimeout
    • setTag
    • setUserAlias
    • unregister
    • unsetDynamicValue
    • update

    Constructors

    constructor

    + new Client(gatewayUrl: string, applicationId: string): Client

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

    Parameters:

    Name Type Description
    gatewayUrl string The gateway URL.
    applicationId string The application identifier.

    Returns: Client

    Inherited from: Dynamic

    Defined in: Generated/TypeScript/fm.liveswitch/Client.ts:120

    + new Client(gatewayUrl: string, applicationId: string, userId: string): Client

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

    Parameters:

    Name Type Description
    gatewayUrl string The gateway URL.
    applicationId string The application identifier.
    userId string The user identifier, or null to auto-generate.

    Returns: Client

    Defined in: Generated/TypeScript/fm.liveswitch/Client.ts:128

    + new Client(gatewayUrl: string, applicationId: string, userId: string, deviceId: string): Client

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

    Parameters:

    Name Type Description
    gatewayUrl string The gateway URL.
    applicationId string The application identifier.
    userId string The user identifier, or null to auto-generate.
    deviceId string The device identifier, or null to auto-generate.

    Returns: Client

    Defined in: Generated/TypeScript/fm.liveswitch/Client.ts:137

    + new Client(gatewayUrl: string, applicationId: string, userId: string, deviceId: string, clientId: string): Client

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

    Parameters:

    Name Type Description
    gatewayUrl string The gateway URL.
    applicationId string The application identifier.
    userId string The user identifier, or null to auto-generate.
    deviceId string The device identifier, or null to auto-generate.
    clientId string The client identifier, or null to auto-generate.

    Returns: Client

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

    + new Client(gatewayUrl: string, applicationId: string, userId: string, deviceId: string, clientId: string, roles: string[]): Client

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

    Parameters:

    Name Type Description
    gatewayUrl string The gateway URL.
    applicationId string The application identifier.
    userId string The user identifier, or null to auto-generate.
    deviceId string The device identifier, or null to auto-generate.
    clientId string The client identifier, or null to auto-generate.
    roles string[] The roles, if any.

    Returns: Client

    Defined in: Generated/TypeScript/fm.liveswitch/Client.ts:158

    + new Client(gatewayUrl: string, applicationId: string, userId: string, deviceId: string, clientId: string, roles: string[], region: string): Client

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

    Parameters:

    Name Type Description
    gatewayUrl string The gateway URL.
    applicationId string The application identifier.
    userId string The user identifier, or null to auto-generate.
    deviceId string The device identifier, or null to auto-generate.
    clientId string The client identifier, or null to auto-generate.
    roles string[] The roles, if any.
    region string The region, if any.

    Returns: Client

    Defined in: Generated/TypeScript/fm.liveswitch/Client.ts:170

    Methods

    addOnApplicationMessage

    ▸ addOnApplicationMessage(value: IAction2<ClientInfo, string>): void

    Adds a handler that is raised when an application-scope message is received from the server. Parameters:

    • clientInfo - the sending client information
    • message - the message

    Parameters:

    Name Type
    value IAction2<ClientInfo, string>

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/Client.ts:744


    addOnDeviceMessage

    ▸ addOnDeviceMessage(value: IAction2<ClientInfo, string>): void

    Adds a handler that is raised when a device-scope message is received from the server. Parameters:

    • clientInfo - the sending client information
    • message - the message

    Parameters:

    Name Type
    value IAction2<ClientInfo, string>

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/Client.ts:759


    addOnHttpRequestCreated

    ▸ addOnHttpRequestCreated(value: IAction1<HttpRequestCreatedArgs>): void

    Adds a handler that is raised whenever an underlying HTTP request has been created and is about to be transferred to the server. This is a good place to add headers/cookies. For WebSocket streams, this will fire only once for the initial HTTP-based handshake.

    Parameters:

    Name Type
    value IAction1<HttpRequestCreatedArgs>

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/Client.ts:774


    addOnHttpResponseReceived

    ▸ addOnHttpResponseReceived(value: IAction1<HttpResponseReceivedArgs>): void

    Adds a handler that is raised whenever an underlying HTTP response has been received and is about to be processed by the client. This is a good place to read headers/cookies. For WebSocket streams, this will fire only once for the initial HTTP-based handshake.

    Parameters:

    Name Type
    value IAction1<HttpResponseReceivedArgs>

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/Client.ts:789


    addOnMessage

    ▸ addOnMessage(value: IAction2<ClientInfo, string>): void

    Adds a handler that is raised when a client-scope message is received from the server. Parameters:

    • clientInfo - the sending client information
    • message - the message

    Parameters:

    Name Type
    value IAction2<ClientInfo, string>

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/Client.ts:804


    addOnRemoteUpdate

    ▸ addOnRemoteUpdate(value: IAction2<ClientInfo, ClientInfo>): void

    Adds a handler that is raised when the the client's config on the server has changed.

    Parameters:

    Name Type
    value IAction2<ClientInfo, ClientInfo>

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/Client.ts:816


    addOnStateChange

    ▸ addOnStateChange(value: IAction1<Client>): void

    Adds a handler that is raised when the state changes.

    Parameters:

    Name Type
    value IAction1<Client>

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/Client.ts:828


    addOnUserMessage

    ▸ addOnUserMessage(value: IAction2<ClientInfo, string>): void

    Adds a handler that is raised when a user-scope message is received from the server. Parameters:

    • clientInfo - the sending client information
    • message - the message

    Parameters:

    Name Type
    value IAction2<ClientInfo, string>

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/Client.ts:843


    closeAll

    ▸ closeAll(): Future<Object>

    Closes all active connections in all channels.

    Returns: Future<Object>

    Defined in: Generated/TypeScript/fm.liveswitch/Client.ts:866


    fmliveswitchClientInit

    ▸ PrivatefmliveswitchClientInit(): void

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/Client.ts:102


    getApplicationId

    ▸ getApplicationId(): string

    Gets the application identifier.

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/Client.ts:1279


    getAutoUnregister

    ▸ getAutoUnregister(): boolean

    Gets whether to unregister automatically when the page unloads.

    Returns: boolean

    Defined in: Generated/TypeScript/fm.liveswitch/Client.ts:1291


    getChannels

    ▸ getChannels(): Channel[]

    Gets an array of joined channels.

    Returns: Channel[]

    Defined in: Generated/TypeScript/fm.liveswitch/Client.ts:1303


    getConfig

    ▸ getConfig(): ClientConfig

    Gets the current configuration.

    Returns: ClientConfig

    Defined in: Generated/TypeScript/fm.liveswitch/Client.ts:1319


    getDeviceAlias

    ▸ getDeviceAlias(): string

    Gets the device alias. Cannot be set after registration, use the 'Update' method instead.

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/Client.ts:1336


    getDeviceId

    ▸ getDeviceId(): string

    Gets the device identifier.

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/Client.ts:1348


    getDisableCors

    ▸ getDisableCors(): boolean

    Gets a value indicating whether to disable the cross-origin resource sharing (CORS) transport.

    Returns: boolean

    Defined in: Generated/TypeScript/fm.liveswitch/Client.ts:1360


    getDisableJsonp

    ▸ getDisableJsonp(): boolean

    Gets a value indicating whether to disable the JSON-P transport.

    Returns: boolean

    Defined in: Generated/TypeScript/fm.liveswitch/Client.ts:1372


    getDisablePostMessage

    ▸ getDisablePostMessage(): boolean

    Gets a value indicating whether to disable the postMessage transport.

    Returns: boolean

    Defined in: Generated/TypeScript/fm.liveswitch/Client.ts:1384


    getDisableWebSockets

    ▸ getDisableWebSockets(): boolean

    Gets whether to disable WebSocket protocol support and use long-polling, even if the server is capable of accepting WebSocket requests.

    Returns: boolean

    Defined in: Generated/TypeScript/fm.liveswitch/Client.ts:1397


    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


    getExternalId

    ▸ getExternalId(): string

    Gets the external client identifier.

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/Client.ts:1409


    getForceJsonp

    ▸ getForceJsonp(): boolean

    Gets a value indicating whether to force the JSON-P transport.

    Returns: boolean

    Defined in: Generated/TypeScript/fm.liveswitch/Client.ts:1421


    getGatewayUrl

    ▸ getGatewayUrl(): string

    Gets the gateway URL.

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/Client.ts:1433


    getId

    ▸ getId(): string

    Gets the client identifier.

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/Client.ts:1445


    getInfo

    ▸ getInfo(): ClientInfo

    Gets the client info.

    Returns: ClientInfo

    Defined in: Generated/TypeScript/fm.liveswitch/Client.ts:1457


    getMessageBytesReceived

    ▸ getMessageBytesReceived(): number

    Gets the number of message bytes received.

    Returns: number

    Defined in: Generated/TypeScript/fm.liveswitch/Client.ts:1488


    getMessageBytesSent

    ▸ getMessageBytesSent(): number

    Gets the number of message bytes sent.

    Returns: number

    Defined in: Generated/TypeScript/fm.liveswitch/Client.ts:1500


    getMessagesReceived

    ▸ getMessagesReceived(): number

    Gets the number of messages received.

    Returns: number

    Defined in: Generated/TypeScript/fm.liveswitch/Client.ts:1512


    getMessagesSent

    ▸ getMessagesSent(): number

    Gets the number of messages sent.

    Returns: number

    Defined in: Generated/TypeScript/fm.liveswitch/Client.ts:1524


    getRegion

    ▸ getRegion(): string

    Gets the region.

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/Client.ts:1536


    getRequestMaxRetries

    ▸ getRequestMaxRetries(): number

    Gets the maximum number of retries allowed for a standard request.

    Returns: number

    Defined in: Generated/TypeScript/fm.liveswitch/Client.ts:1562


    getRequestTimeout

    ▸ getRequestTimeout(): number

    Gets the number of milliseconds to wait for a standard request to return a response before it is aborted and another request is attempted. Defaults to 15000 (15 seconds).

    Returns: number

    Defined in: Generated/TypeScript/fm.liveswitch/Client.ts:1576


    getRoles

    ▸ getRoles(): string[]

    Gets the roles.

    Returns: string[]

    Defined in: Generated/TypeScript/fm.liveswitch/Client.ts:1588


    getState

    ▸ getState(): ClientState

    Gets the state.

    Returns: ClientState

    Defined in: Generated/TypeScript/fm.liveswitch/Client.ts:1600


    getTag

    ▸ getTag(): string

    Gets the tag. Cannot be set after registration, use the 'Update' method instead.

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/Client.ts:1612


    getTypeString

    ▸ getTypeString(): string

    Returns: string

    Overrides: Dynamic

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


    getUnregisterException

    ▸ getUnregisterException(): Exception

    Gets the unregister exception, which is set if registration is reset abnormally.

    Returns: Exception

    Defined in: Generated/TypeScript/fm.liveswitch/Client.ts:1625


    getUserAlias

    ▸ getUserAlias(): string

    Gets the user alias. Cannot be set after registration, use the 'Update' method instead.

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/Client.ts:1637


    getUserId

    ▸ getUserId(): string

    Gets the user identifier.

    Returns: string

    Defined in: Generated/TypeScript/fm.liveswitch/Client.ts:1649


    join

    ▸ join(channelId: string, token: string): Future<Channel>

    Joins a channel.

    Parameters:

    Name Type Description
    channelId string The channel identifier.
    token string The auth token.

    Returns: Future<Channel>

    A future with the joined channel.

    Defined in: Generated/TypeScript/fm.liveswitch/Client.ts:1666

    ▸ join(token: string): Future<Channel>

    Joins a channel.

    Parameters:

    Name Type Description
    token string The auth token.

    Returns: Future<Channel>

    A future with the joined channel.

    Defined in: Generated/TypeScript/fm.liveswitch/Client.ts:1676


    leave

    ▸ leave(channelId: string): Future<Channel>

    Leaves a channel.

    Parameters:

    Name Type Description
    channelId string The channel identifier.

    Returns: Future<Channel>

    Defined in: Generated/TypeScript/fm.liveswitch/Client.ts:1723


    register

    ▸ register(token: string): Future<Channel[]>

    Registers with the signalling server.

    Parameters:

    Name Type Description
    token string The auth token.

    Returns: Future<Channel[]>

    A future with an array of initial channels as instructed by the auth token.

    Defined in: Generated/TypeScript/fm.liveswitch/Client.ts:1875


    removeOnApplicationMessage

    ▸ removeOnApplicationMessage(value: IAction2<ClientInfo, string>): void

    Removes a handler that is raised when an application-scope message is received from the server. Parameters:

    • clientInfo - the sending client information
    • message - the message

    Parameters:

    Name Type
    value IAction2<ClientInfo, string>

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/Client.ts:1934


    removeOnDeviceMessage

    ▸ removeOnDeviceMessage(value: IAction2<ClientInfo, string>): void

    Removes a handler that is raised when a device-scope message is received from the server. Parameters:

    • clientInfo - the sending client information
    • message - the message

    Parameters:

    Name Type
    value IAction2<ClientInfo, string>

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/Client.ts:1949


    removeOnHttpRequestCreated

    ▸ removeOnHttpRequestCreated(value: IAction1<HttpRequestCreatedArgs>): void

    Removes a handler that is raised whenever an underlying HTTP request has been created and is about to be transferred to the server. This is a good place to add headers/cookies. For WebSocket streams, this will fire only once for the initial HTTP-based handshake.

    Parameters:

    Name Type
    value IAction1<HttpRequestCreatedArgs>

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/Client.ts:1964


    removeOnHttpResponseReceived

    ▸ removeOnHttpResponseReceived(value: IAction1<HttpResponseReceivedArgs>): void

    Removes a handler that is raised whenever an underlying HTTP response has been received and is about to be processed by the client. This is a good place to read headers/cookies. For WebSocket streams, this will fire only once for the initial HTTP-based handshake.

    Parameters:

    Name Type
    value IAction1<HttpResponseReceivedArgs>

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/Client.ts:1979


    removeOnMessage

    ▸ removeOnMessage(value: IAction2<ClientInfo, string>): void

    Removes a handler that is raised when a client-scope message is received from the server. Parameters:

    • clientInfo - the sending client information
    • message - the message

    Parameters:

    Name Type
    value IAction2<ClientInfo, string>

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/Client.ts:1994


    removeOnRemoteUpdate

    ▸ removeOnRemoteUpdate(value: IAction2<ClientInfo, ClientInfo>): void

    Removes a handler that is raised when the the client's config on the server has changed.

    Parameters:

    Name Type
    value IAction2<ClientInfo, ClientInfo>

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/Client.ts:2006


    removeOnStateChange

    ▸ removeOnStateChange(value: IAction1<Client>): void

    Removes a handler that is raised when the state changes.

    Parameters:

    Name Type
    value IAction1<Client>

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/Client.ts:2018


    removeOnUserMessage

    ▸ removeOnUserMessage(value: IAction2<ClientInfo, string>): void

    Removes a handler that is raised when a user-scope message is received from the server. Parameters:

    • clientInfo - the sending client information
    • message - the message

    Parameters:

    Name Type
    value IAction2<ClientInfo, string>

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/Client.ts:2033


    sendMessage

    ▸ sendMessage(message: string): Future<Object>

    Sends a message to the server with no delivery.

    Parameters:

    Name Type Description
    message string The message to be sent.

    Returns: Future<Object>

    Defined in: Generated/TypeScript/fm.liveswitch/Client.ts:2103


    setAutoUnregister

    ▸ setAutoUnregister(value: boolean): void

    Sets whether to unregister automatically when the page unloads.

    Parameters:

    Name Type
    value boolean

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/Client.ts:2128


    setDeviceAlias

    ▸ setDeviceAlias(value: string): void

    Sets the device alias. Cannot be set after registration, use the 'Update' method instead.

    Parameters:

    Name Type
    value string

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/Client.ts:2140


    setDisableCors

    ▸ setDisableCors(value: boolean): void

    Sets a value indicating whether to disable the cross-origin resource sharing (CORS) transport.

    Parameters:

    Name Type
    value boolean

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/Client.ts:2168


    setDisableJsonp

    ▸ setDisableJsonp(value: boolean): void

    Sets a value indicating whether to disable the JSON-P transport.

    Parameters:

    Name Type
    value boolean

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/Client.ts:2180


    setDisablePostMessage

    ▸ setDisablePostMessage(value: boolean): void

    Sets a value indicating whether to disable the postMessage transport.

    Parameters:

    Name Type
    value boolean

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/Client.ts:2192


    setDisableWebSockets

    ▸ setDisableWebSockets(value: boolean): void

    Sets whether to disable WebSocket protocol support and use long-polling, even if the server is capable of accepting WebSocket requests.

    Parameters:

    Name Type
    value boolean

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/Client.ts:2205


    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


    setExternalId

    ▸ setExternalId(value: string): void

    Sets the external client identifier.

    Parameters:

    Name Type
    value string

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/Client.ts:2217


    setForceJsonp

    ▸ setForceJsonp(value: boolean): void

    Sets a value indicating whether to force the JSON-P transport.

    Parameters:

    Name Type
    value boolean

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/Client.ts:2229


    setRequestMaxRetries

    ▸ setRequestMaxRetries(value: number): void

    Sets the maximum number of retries allowed for a standard request.

    Parameters:

    Name Type
    value number

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/Client.ts:2257


    setRequestTimeout

    ▸ setRequestTimeout(value: number): void

    Sets the number of milliseconds to wait for a standard request to return a response before it is aborted and another request is attempted. Defaults to 15000 (15 seconds).

    Parameters:

    Name Type
    value number

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/Client.ts:2272


    setTag

    ▸ setTag(value: string): void

    Sets the tag. Cannot be set after registration, use the 'Update' method instead.

    Parameters:

    Name Type
    value string

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/Client.ts:2316


    setUserAlias

    ▸ setUserAlias(value: string): void

    Sets the user alias. Cannot be set after registration, use the 'Update' method instead.

    Parameters:

    Name Type
    value string

    Returns: void

    Defined in: Generated/TypeScript/fm.liveswitch/Client.ts:2336


    unregister

    ▸ unregister(): Future<Object>

    Unregisters with the signalling server.

    Returns: Future<Object>

    A future that resolves when successfully unregistered.

    Defined in: Generated/TypeScript/fm.liveswitch/Client.ts:2418


    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


    update

    ▸ update(clientConfig: ClientConfig): Future<Object>

    Updates this client.

    Parameters:

    Name Type Description
    clientConfig ClientConfig The client configuration.

    Returns: Future<Object>

    A future that resolves when the client has been updated.

    Defined in: Generated/TypeScript/fm.liveswitch/Client.ts:2434

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