/ fm / liveswitch / WebSocketOpenArgs

Class: WebSocketOpenArgs

fm.liveswitch.WebSocketOpenArgs

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

Hierarchy

Table of contents

Constructors

Methods

Constructors

constructor

+ new WebSocketOpenArgs(): WebSocketOpenArgs

Creates a new instance of

Returns: WebSocketOpenArgs

Inherited from: Dynamic

Defined in: Generated/TypeScript/fm.liveswitch/WebSocketOpenArgs.ts:41

Methods

fmliveswitchWebSocketOpenArgsInit

▸ PrivatefmliveswitchWebSocketOpenArgsInit(): void

Returns: void

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

getHandshakeTimeout

▸ getHandshakeTimeout(): number

Gets the timeout for the handshake (in ms).

Returns: number

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

getHeaders

▸ getHeaders(): ManagedConcurrentDictionary<string, string>

Gets headers to send with the handshake request.

Returns: ManagedConcurrentDictionary<string, string>

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

getKeepAliveInterval

▸ getKeepAliveInterval(): number

Gets the keep-alive interval for the stream (in ms). Defaults to 5,000.

Returns: number

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

getOnFailure

▸ getOnFailure(): IAction1<WebSocketOpenFailureArgs>

Gets the callback to invoke when a connection could not be established.

Returns: IAction1<WebSocketOpenFailureArgs>

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

getOnReceive

▸ getOnReceive(): IAction1<WebSocketReceiveArgs>

Gets the callback to invoke when a message is received.

Returns: IAction1<WebSocketReceiveArgs>

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

getOnRequestCreated

▸ getOnRequestCreated(): IAction1<HttpRequestCreatedArgs>

Gets the callback to invoke before the handshake request is sent.

Returns: IAction1<HttpRequestCreatedArgs>

Defined in: Generated/TypeScript/fm.liveswitch/WebSocketOpenArgs.ts:127

getOnResponseReceived

▸ getOnResponseReceived(): IAction1<HttpResponseReceivedArgs>

Gets the callback to invoke after the handshake response is received.

Returns: IAction1<HttpResponseReceivedArgs>

Defined in: Generated/TypeScript/fm.liveswitch/WebSocketOpenArgs.ts:139

getOnStreamFailure

▸ getOnStreamFailure(): IAction1<WebSocketStreamFailureArgs>

Gets the callback to invoke when a successful connection breaks down.

Returns: IAction1<WebSocketStreamFailureArgs>

Defined in: Generated/TypeScript/fm.liveswitch/WebSocketOpenArgs.ts:151

getOnSuccess

▸ getOnSuccess(): IAction1<WebSocketOpenSuccessArgs>

Gets the callback to invoke when a successful connection has been established.

Returns: IAction1<WebSocketOpenSuccessArgs>

Defined in: Generated/TypeScript/fm.liveswitch/WebSocketOpenArgs.ts:163

getSender

▸ getSender(): Object

Gets the sender of the request.

Returns: Object

Defined in: Generated/TypeScript/fm.liveswitch/WebSocketOpenArgs.ts:175

getStreamTimeout

▸ getStreamTimeout(): number

Gets the timeout for the stream (in ms).

Returns: number

Defined in: Generated/TypeScript/fm.liveswitch/WebSocketOpenArgs.ts:187

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: Dynamic

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

setHandshakeTimeout

▸ setHandshakeTimeout(value: number): void

Sets the timeout for the handshake (in ms).

Parameters:

Name Type
value number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebSocketOpenArgs.ts:199

setHeaders

▸ setHeaders(value: ManagedConcurrentDictionary<string, string>): void

Sets headers to send with the handshake request.

Parameters:

Name Type
value ManagedConcurrentDictionary<string, string>

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebSocketOpenArgs.ts:212

setKeepAliveInterval

▸ setKeepAliveInterval(value: number): void

Sets the keep-alive interval for the stream (in ms). Defaults to 5,000.

Parameters:

Name Type
value number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebSocketOpenArgs.ts:224

setOnFailure

▸ setOnFailure(value: IAction1<WebSocketOpenFailureArgs>): void

Sets the callback to invoke when a connection could not be established.

Parameters:

Name Type
value IAction1<WebSocketOpenFailureArgs>

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebSocketOpenArgs.ts:237

setOnReceive

▸ setOnReceive(value: IAction1<WebSocketReceiveArgs>): void

Sets the callback to invoke when a message is received.

Parameters:

Name Type
value IAction1<WebSocketReceiveArgs>

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebSocketOpenArgs.ts:249

setOnRequestCreated

▸ setOnRequestCreated(value: IAction1<HttpRequestCreatedArgs>): void

Sets the callback to invoke before the handshake request is sent.

Parameters:

Name Type
value IAction1<HttpRequestCreatedArgs>

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebSocketOpenArgs.ts:261

setOnResponseReceived

▸ setOnResponseReceived(value: IAction1<HttpResponseReceivedArgs>): void

Sets the callback to invoke after the handshake response is received.

Parameters:

Name Type
value IAction1<HttpResponseReceivedArgs>

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebSocketOpenArgs.ts:273

setOnStreamFailure

▸ setOnStreamFailure(value: IAction1<WebSocketStreamFailureArgs>): void

Sets the callback to invoke when a successful connection breaks down.

Parameters:

Name Type
value IAction1<WebSocketStreamFailureArgs>

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebSocketOpenArgs.ts:285

setOnSuccess

▸ setOnSuccess(value: IAction1<WebSocketOpenSuccessArgs>): void

Sets the callback to invoke when a successful connection has been established.

Parameters:

Name Type
value IAction1<WebSocketOpenSuccessArgs>

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebSocketOpenArgs.ts:297

setSender

▸ setSender(value: Object): void

Sets the sender of the request.

Parameters:

Name Type
value Object

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebSocketOpenArgs.ts:309

setStreamTimeout

▸ setStreamTimeout(value: number): void

Sets the timeout for the stream (in ms).

Parameters:

Name Type
value number

Returns: void

Defined in: Generated/TypeScript/fm.liveswitch/WebSocketOpenArgs.ts:321

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:125