/ fm / liveswitch / IDataChannel
Interface: IDataChannel<TDataChannel>
fm.liveswitch.IDataChannel
Data channel interface.
Type parameters
Name |
---|
TDataChannel |
Hierarchy
IDataChannel
Implemented by
Table of contents
Methods
- addOnStateChange
- getId
- getInfo
- getIsInternal
- getLabel
- getOnReceive
- getOrdered
- getState
- getSubprotocol
- removeOnStateChange
- sendDataBytes
- sendDataString
- setOnReceive
Methods
addOnStateChange
▸ addOnStateChange(value
: IAction1<TDataChannel>): void
Parameters:
Name | Type |
---|---|
value |
IAction1<TDataChannel> |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/IDataChannel.ts:9
getId
▸ getId(): string
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/IDataChannel.ts:10
getInfo
▸ getInfo(): DataChannelInfo
Returns: DataChannelInfo
Defined in: Generated/TypeScript/fm.liveswitch/IDataChannel.ts:11
getIsInternal
▸ getIsInternal(): boolean
Returns: boolean
Defined in: Generated/TypeScript/fm.liveswitch/IDataChannel.ts:12
getLabel
▸ getLabel(): string
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/IDataChannel.ts:13
getOnReceive
▸ getOnReceive(): IAction1<DataChannelReceiveArgs>
Returns: IAction1<DataChannelReceiveArgs>
Defined in: Generated/TypeScript/fm.liveswitch/IDataChannel.ts:14
getOrdered
▸ getOrdered(): boolean
Returns: boolean
Defined in: Generated/TypeScript/fm.liveswitch/IDataChannel.ts:15
getState
▸ getState(): DataChannelState
Returns: DataChannelState
Defined in: Generated/TypeScript/fm.liveswitch/IDataChannel.ts:16
getSubprotocol
▸ getSubprotocol(): string
Returns: string
Defined in: Generated/TypeScript/fm.liveswitch/IDataChannel.ts:17
removeOnStateChange
▸ removeOnStateChange(value
: IAction1<TDataChannel>): void
Parameters:
Name | Type |
---|---|
value |
IAction1<TDataChannel> |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/IDataChannel.ts:18
sendDataBytes
▸ sendDataBytes(dataBytes
: DataBuffer): Future<Object>
Parameters:
Name | Type |
---|---|
dataBytes |
DataBuffer |
Returns: Future<Object>
Defined in: Generated/TypeScript/fm.liveswitch/IDataChannel.ts:19
sendDataString
▸ sendDataString(dataString
: string): Future<Object>
Parameters:
Name | Type |
---|---|
dataString |
string |
Returns: Future<Object>
Defined in: Generated/TypeScript/fm.liveswitch/IDataChannel.ts:20
setOnReceive
▸ setOnReceive(value
: IAction1<DataChannelReceiveArgs>): void
Parameters:
Name | Type |
---|---|
value |
IAction1<DataChannelReceiveArgs> |
Returns: void
Defined in: Generated/TypeScript/fm.liveswitch/IDataChannel.ts:21