/ fm / liveswitch / WebSocketSendArgs

Class: WebSocketSendArgs

fm.liveswitch.WebSocketSendArgs

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

Hierarchy

• Dynamic

  ↳ WebSocketSendArgs

Table of contents

Constructors

• constructor

Methods

• fmliveswitchWebSocketSendArgsInit
• getBinaryMessage
• getDynamicProperties
• getDynamicValue
• getTextMessage
• getTimeout
• getTypeString
• setBinaryMessage
• setDynamicValue
• setTextMessage
• setTimeout
• unsetDynamicValue

Constructors

constructor

+ new WebSocketSendArgs(): WebSocketSendArgs

Creates a new [[fm.liveswitch.webSocketSendArgs]] instance.

Returns: WebSocketSendArgs

Inherited from: Dynamic

Defined in: Generated/TypeScript/fm.liveswitch/WebSocketSendArgs.ts:23

Methods

fmliveswitchWebSocketSendArgsInit

▸ PrivatefmliveswitchWebSocketSendArgsInit(): void

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebSocketSendArgs.ts:20

---

getBinaryMessage

▸ getBinaryMessage(): Uint8Array

Gets the message to send as binary data.

Returns: Uint8Array

Defined in: Generated/TypeScript/fm.liveswitch/WebSocketSendArgs.ts:47

---

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

---

getTextMessage

▸ getTextMessage(): string

Gets the message to send as text data.

Returns: string

Defined in: Generated/TypeScript/fm.liveswitch/WebSocketSendArgs.ts:67

---

getTimeout

▸ getTimeout(): number

Gets the timeout for the request (in ms).

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/WebSocketSendArgs.ts:79

---

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: Dynamic

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

---

setBinaryMessage

▸ setBinaryMessage(value: Uint8Array): void

Sets the message to send as binary data.

Parameters:

Name	Type
value	Uint8Array

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebSocketSendArgs.ts:91

---

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

---

setTextMessage

▸ setTextMessage(value: string): void

Sets the message to send as text data.

Parameters:

Name	Type
value	string

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebSocketSendArgs.ts:103

---

setTimeout

▸ setTimeout(value: number): void

Sets the timeout for the request (in ms).

Parameters:

Name	Type
value	number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebSocketSendArgs.ts:115

---

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