/ 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

Methods

fmliveswitchWebSocketOpenArgsInit

▸ PrivatefmliveswitchWebSocketOpenArgsInit(): void

Returns: void

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

getHandshakeTimeout

▸ getHandshakeTimeout(): number

Gets the timeout for the handshake (in ms).

Returns: number

getHeaders

▸ getHeaders(): NameValueCollection

Gets headers to send with the handshake request.

Returns: NameValueCollection

getOnFailure

▸ getOnFailure(): IAction1<WebSocketOpenFailureArgs>

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

Returns: IAction1<WebSocketOpenFailureArgs>

getOnReceive

▸ getOnReceive(): IAction1<WebSocketReceiveArgs>

Gets the callback to invoke when a message is received.

Returns: IAction1<WebSocketReceiveArgs>

getOnRequestCreated

▸ getOnRequestCreated(): IAction1<HttpRequestCreatedArgs>

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

Returns: IAction1<HttpRequestCreatedArgs>

getOnResponseReceived

▸ getOnResponseReceived(): IAction1<HttpResponseReceivedArgs>

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

Returns: IAction1<HttpResponseReceivedArgs>

getOnStreamFailure

▸ getOnStreamFailure(): IAction1<WebSocketStreamFailureArgs>

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

Returns: IAction1<WebSocketStreamFailureArgs>

getOnSuccess

▸ getOnSuccess(): IAction1<WebSocketOpenSuccessArgs>

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

Returns: IAction1<WebSocketOpenSuccessArgs>

getSender

▸ getSender(): Object

Gets the sender of the request.

Returns: Object

getStreamTimeout

▸ getStreamTimeout(): number

Gets the timeout for the stream (in ms).

Returns: number

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: Dynamic

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

setHandshakeTimeout

▸ setHandshakeTimeout(value: number): void

Sets the timeout for the handshake (in ms).

Parameters:

Name Type
value number

Returns: void

setHeaders

▸ setHeaders(value: NameValueCollection): void

Sets headers to send with the handshake request.

Parameters:

Name Type
value NameValueCollection

Returns: void

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

setOnReceive

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

Sets the callback to invoke when a message is received.

Parameters:

Name Type
value IAction1<WebSocketReceiveArgs>

Returns: void

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

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

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

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

setSender

▸ setSender(value: Object): void

Sets the sender of the request.

Parameters:

Name Type
value Object

Returns: void

setStreamTimeout

▸ setStreamTimeout(value: number): void

Sets the timeout for the stream (in ms).

Parameters:

Name Type
value number

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