/ fm / liveswitch / WebSocketCloseCompleteArgs

Class: WebSocketCloseCompleteArgs

fm.liveswitch.WebSocketCloseCompleteArgs

Arguments for [[fm.liveswitch.webSocketCloseArgs.onComplete]].

Hierarchy

  • Dynamic

    ↳ WebSocketCloseCompleteArgs

Table of contents

Constructors

Methods

Constructors

constructor

+ new WebSocketCloseCompleteArgs(): WebSocketCloseCompleteArgs

Returns: WebSocketCloseCompleteArgs

Inherited from: Dynamic

Defined in: Generated/TypeScript/fm.liveswitch/WebSocketCloseCompleteArgs.ts:18

Methods

getCloseArgs

▸ getCloseArgs(): WebSocketCloseArgs

Gets the original arguments passed to the close method.

Returns: WebSocketCloseArgs

Defined in: Generated/TypeScript/fm.liveswitch/WebSocketCloseCompleteArgs.ts:36

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

getReason

▸ getReason(): string

Gets the reason given for closing the connection.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/WebSocketCloseCompleteArgs.ts:48

getStatusCode

▸ getStatusCode(): WebSocketStatusCode

Gets the status code associated with the close operation.

Returns: WebSocketStatusCode

Defined in: Generated/TypeScript/fm.liveswitch/WebSocketCloseCompleteArgs.ts:60

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: Dynamic

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

setCloseArgs

▸ setCloseArgs(value: WebSocketCloseArgs): void

Sets the original arguments passed to the close method.

Parameters:

Name Type
value WebSocketCloseArgs

Returns: void

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

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

setReason

▸ setReason(value: string): void

Sets the reason given for closing the connection.

Parameters:

Name Type
value string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebSocketCloseCompleteArgs.ts:84

setStatusCode

▸ setStatusCode(value: WebSocketStatusCode): void

Sets the status code associated with the close operation.

Parameters:

Name Type
value WebSocketStatusCode

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebSocketCloseCompleteArgs.ts:96

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