/ fm / liveswitch / WebSocketReceiveArgs

Class: WebSocketReceiveArgs

fm.liveswitch.WebSocketReceiveArgs

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

Hierarchy

Table of contents

Constructors

Methods

Constructors

constructor

+ new WebSocketReceiveArgs(): WebSocketReceiveArgs

Returns: WebSocketReceiveArgs

Inherited from: Dynamic

Methods

getBinaryMessage

▸ getBinaryMessage(): Uint8Array

Gets the message received from the server as binary data.

Returns: Uint8Array

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

getIsText

▸ getIsText(): boolean

Gets whether or not the received message is text.

Returns: boolean

getOpenArgs

▸ getOpenArgs(): WebSocketOpenArgs

Gets the original arguments passed to the open method.

Returns: WebSocketOpenArgs

getTextMessage

▸ getTextMessage(): string

Gets the message received from the server as text data.

Returns: string

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: Dynamic

setBinaryMessage

▸ setBinaryMessage(value: Uint8Array): void

Sets the message received from the server as binary data.

Parameters:

Name Type
value Uint8Array

Returns: void

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

setOpenArgs

▸ setOpenArgs(value: WebSocketOpenArgs): void

Sets the original arguments passed to the open method.

Parameters:

Name Type
value WebSocketOpenArgs

Returns: void

setTextMessage

▸ setTextMessage(value: string): void

Sets the message received from the server as text data.

Parameters:

Name Type
value string

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