/ fm / liveswitch / DataChannel

Class: DataChannel

fm.liveswitch.DataChannel

Hierarchy

Implements

Table of contents

Constructors

Methods

Constructors

constructor

+ new DataChannel(label: string, ordered?: boolean, subprotocol?: string): DataChannel

Parameters:

Name Type
label string
ordered? boolean
subprotocol? string

Returns: DataChannel

Inherited from: Dynamic

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

Methods

addOnStateChange

▸ addOnStateChange(value: IAction1<DataChannel>): void

Parameters:

Name Type
value IAction1<DataChannel>

Returns: void

Implementation of: IExternalDataChannel

Defined in: fm/Generated/TypeScript/fm.liveswitch/DataChannel.ts:98

getDynamicProperties

▸ getDynamicProperties(): Hash<string, Object>

Gets the dynamic properties on this instance.

Returns: Hash<string, Object>

Inherited from: Dynamic

Defined in: fm/Generated/TypeScript/fm.liveswitch/Dynamic.ts:32

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: fm/Generated/TypeScript/fm.liveswitch/Dynamic.ts:51

getId

▸ getId(): string

Returns: string

Implementation of: IExternalDataChannel

Defined in: fm/Generated/TypeScript/fm.liveswitch/DataChannel.ts:90

getInfo

▸ getInfo(): DataChannelInfo

Returns: DataChannelInfo

Implementation of: IExternalDataChannel

Defined in: fm/Generated/TypeScript/fm.liveswitch/DataChannel.ts:15

getLabel

▸ getLabel(): string

Returns: string

Implementation of: IExternalDataChannel

Defined in: fm/Generated/TypeScript/fm.liveswitch/DataChannel.ts:86

getOnReceive

▸ getOnReceive(): IAction1<DataChannelReceiveArgs>

Returns: IAction1<DataChannelReceiveArgs>

Implementation of: IExternalDataChannel

Defined in: fm/Generated/TypeScript/fm.liveswitch/DataChannel.ts:70

getOrdered

▸ getOrdered(): boolean

Returns: boolean

Implementation of: IExternalDataChannel

Defined in: fm/Generated/TypeScript/fm.liveswitch/DataChannel.ts:94

getState

▸ getState(): DataChannelState

Returns: DataChannelState

Implementation of: IExternalDataChannel

Defined in: fm/Generated/TypeScript/fm.liveswitch/DataChannel.ts:82

getSubprotocol

▸ getSubprotocol(): string

Returns: string

Implementation of: IExternalDataChannel

Defined in: fm/Generated/TypeScript/fm.liveswitch/DataChannel.ts:66

getTypeString

▸ getTypeString(): string

Returns: string

Overrides: Dynamic

Defined in: fm/Generated/TypeScript/fm.liveswitch/DataChannel.ts:4

removeOnStateChange

▸ removeOnStateChange(value: IAction1<DataChannel>): void

Parameters:

Name Type
value IAction1<DataChannel>

Returns: void

Implementation of: IExternalDataChannel

Defined in: fm/Generated/TypeScript/fm.liveswitch/DataChannel.ts:102

sendDataBytes

▸ sendDataBytes(dataBytes: DataBuffer): Future<Object>

Parameters:

Name Type
dataBytes DataBuffer

Returns: Future<Object>

Implementation of: IExternalDataChannel

Defined in: fm/Generated/TypeScript/fm.liveswitch/DataChannel.ts:78

sendDataString

▸ sendDataString(dataString: string): Future<Object>

Parameters:

Name Type
dataString string

Returns: Future<Object>

Implementation of: IExternalDataChannel

Defined in: fm/Generated/TypeScript/fm.liveswitch/DataChannel.ts:74

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: fm/Generated/TypeScript/fm.liveswitch/Dynamic.ts:86

setOnReceive

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

Parameters:

Name Type
value IAction1<DataChannelReceiveArgs>

Returns: void

Implementation of: IExternalDataChannel

Defined in: fm/Generated/TypeScript/fm.liveswitch/DataChannel.ts:62

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

Defined in: fm/Generated/TypeScript/fm.liveswitch/Dynamic.ts:111