/ fm / liveswitch / WebSocketOpenFailureArgs

Class: WebSocketOpenFailureArgs

fm.liveswitch.WebSocketOpenFailureArgs

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

Hierarchy

  • Dynamic

    ↳ WebSocketOpenFailureArgs

Table of contents

Constructors

Methods

Constructors

constructor

+ new WebSocketOpenFailureArgs(): WebSocketOpenFailureArgs

Returns: WebSocketOpenFailureArgs

Inherited from: Dynamic

Methods

getDynamicProperties

▸ getDynamicProperties(): Hash<string, Object>

Gets the dynamic properties on this instance.

Returns: Hash<string, Object>

Inherited from: Dynamic

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

getException

▸ getException(): Exception

Gets the exception generated while connecting.

Returns: Exception

getOpenArgs

▸ getOpenArgs(): WebSocketOpenArgs

Gets the original arguments passed to the open method.

Returns: WebSocketOpenArgs

getStatusCode

▸ getStatusCode(): WebSocketStatusCode

Gets the status code associated with the failure to connect.

Returns: WebSocketStatusCode

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: Dynamic

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

setException

▸ setException(value: Exception): void

Sets the exception generated while connecting.

Parameters:

Name Type
value Exception

Returns: void

setOpenArgs

▸ setOpenArgs(value: WebSocketOpenArgs): void

Sets the original arguments passed to the open method.

Parameters:

Name Type
value WebSocketOpenArgs

Returns: void

setStatusCode

▸ setStatusCode(value: WebSocketStatusCode): void

Sets the status code associated with the failure to connect.

Parameters:

Name Type
value WebSocketStatusCode

Returns: void

unsetDynamicValue

▸ unsetDynamicValue(key: string): boolean

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

Returns: boolean

true if the value was removed; otherwise, false.

Inherited from: Dynamic