/ fm / liveswitch / WebSocketCloseArgs

Class: WebSocketCloseArgs

fm.liveswitch.WebSocketCloseArgs

Close arguments for the [[fm.liveswitch.webSocket]] class.

Hierarchy

• Dynamic

  ↳ WebSocketCloseArgs

Table of contents

Constructors

• constructor

Methods

• getDynamicProperties
• getDynamicValue
• getOnComplete
• getReason
• getStatusCode
• getTypeString
• setDynamicValue
• setOnComplete
• setReason
• setStatusCode
• unsetDynamicValue

Constructors

constructor

+ new WebSocketCloseArgs(): WebSocketCloseArgs

Creates a new instance of [[fm.liveswitch.webSocketCloseArgs]] with default values.

Returns: WebSocketCloseArgs

Inherited from: Dynamic

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

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

---

getOnComplete

▸ getOnComplete(): IAction1<WebSocketCloseCompleteArgs>

Gets the callback to execute when the connection is closed.

Returns: IAction1<WebSocketCloseCompleteArgs>

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

---

getReason

▸ getReason(): string

Gets the reason to send with the close frame.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/WebSocketCloseArgs.ts:56

---

getStatusCode

▸ getStatusCode(): WebSocketStatusCode

Gets the status code to send with the close frame.

Returns: WebSocketStatusCode

Defined in: Generated/TypeScript/fm.liveswitch/WebSocketCloseArgs.ts:68

---

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: Dynamic

Defined in: Generated/TypeScript/fm.liveswitch/WebSocketCloseArgs.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

---

setOnComplete

▸ setOnComplete(value: IAction1<WebSocketCloseCompleteArgs>): void

Sets the callback to execute when the connection is closed.

Parameters:

Name	Type
value	IAction1<WebSocketCloseCompleteArgs>

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebSocketCloseArgs.ts:80

---

setReason

▸ setReason(value: string): void

Sets the reason to send with the close frame.

Parameters:

Name	Type
value	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebSocketCloseArgs.ts:92

---

setStatusCode

▸ setStatusCode(value: WebSocketStatusCode): void

Sets the status code to send with the close frame.

Parameters:

Name	Type
value	WebSocketStatusCode

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebSocketCloseArgs.ts:104

---

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