/ fm / liveswitch / PluginConnection
Class: PluginConnection
fm.liveswitch.PluginConnection
Hierarchy
-
↳ PluginConnection
Implements
- IConnection<PluginConnection, PluginStream, PluginAudioStream, PluginVideoStream, PluginDataStream>
- IInternalConnection
Table of contents
Constructors
Properties
Methods
- addIceServer
- addIceServers
- addOnExternalIdChange
- addOnGatheringStateChange
- addOnIceConnectionStateChange
- addOnLocalCandidate
- addOnLocalDescription
- addOnRemoteCandidate
- addOnRemoteDescription
- addOnSignallingStateChange
- addOnStateChange
- addRemoteCandidate
- addToWebSocketConnection
- close
- createAnswer
- createOffer
- getAudioStream
- getAudioStreams
- getBundlePolicy
- getCanonicalName
- getDataStream
- getDataStreams
- getDeadStreamTimeout
- getDynamicProperties
- getDynamicValue
- getError
- getExternalId
- getGatheringState
- getHasAudio
- getHasData
- getHasVideo
- getIceConnectionState
- getIceGatherPolicy
- getIceServer
- getIceServers
- getId
- getLegacyTimeout
- getLocalDescription
- getMediaProtocol
- getRemoteDescription
- getSignallingState
- getState
- getStats
- getStreams
- getTieBreaker
- getTimeout
- getTrickleIcePolicy
- getTypeString
- getVideoEnabledUpdateConnectionPolicy
- getVideoRetentionPolicy
- getVideoStream
- getVideoStreams
- removeIceServer
- removeIceServers
- removeOnExternalIdChange
- removeOnGatheringStateChange
- removeOnIceConnectionStateChange
- removeOnLocalCandidate
- removeOnLocalDescription
- removeOnRemoteCandidate
- removeOnRemoteDescription
- removeOnSignallingStateChange
- removeOnStateChange
- setBundlePolicy
- setDeadStreamTimeout
- setDynamicValue
- setError
- setExternalId
- setIceGatherPolicy
- setIceServer
- setIceServers
- setLegacyTimeout
- setLocalDescription
- setRemoteDescription
- setState
- setTieBreaker
- setTimeout
- setTrickleIcePolicy
- setVideoEnabledUpdateConnectionPolicy
- setVideoRetentionPolicy
- unsetDynamicValue
- updateWebSocketConnection
Constructors
constructor
+ new PluginConnection(external
: IExternalConnection, streams
: PluginStream[]): PluginConnection
Parameters:
Name | Type |
---|---|
external |
IExternalConnection |
streams |
PluginStream[] |
Returns: PluginConnection
Inherited from: Dynamic
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:50
Properties
_gatheringState
• Private
_gatheringState: IceGatheringState
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:47
_iceConnectionState
• Private
_iceConnectionState: IceConnectionState
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:48
_signallingState
• Private
_signallingState: SignallingState
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:49
_state
• Private
_state: ConnectionState
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:50
Methods
addIceServer
▸ addIceServer(iceServer
: IceServer): void
Parameters:
Name | Type |
---|---|
iceServer |
IceServer |
Returns: void
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:148
addIceServers
▸ addIceServers(iceServers
: IceServer[]): void
Parameters:
Name | Type |
---|---|
iceServers |
IceServer[] |
Returns: void
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:151
addOnExternalIdChange
▸ addOnExternalIdChange(value
: IAction2<string, string>): void
Parameters:
Name | Type |
---|---|
value |
IAction2<string, string> |
Returns: void
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:157
addOnGatheringStateChange
▸ addOnGatheringStateChange(value
: IAction1<PluginConnection>): void
Parameters:
Name | Type |
---|---|
value |
IAction1<PluginConnection> |
Returns: void
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:163
addOnIceConnectionStateChange
▸ addOnIceConnectionStateChange(value
: IAction1<PluginConnection>): void
Parameters:
Name | Type |
---|---|
value |
IAction1<PluginConnection> |
Returns: void
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:160
addOnLocalCandidate
▸ addOnLocalCandidate(value
: IAction2<PluginConnection, Candidate>): void
Parameters:
Name | Type |
---|---|
value |
IAction2<PluginConnection, Candidate> |
Returns: void
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:154
addOnLocalDescription
▸ addOnLocalDescription(value
: IAction2<PluginConnection, SessionDescription>): void
Parameters:
Name | Type |
---|---|
value |
IAction2<PluginConnection, SessionDescription> |
Returns: void
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:166
addOnRemoteCandidate
▸ addOnRemoteCandidate(value
: IAction2<PluginConnection, Candidate>): void
Parameters:
Name | Type |
---|---|
value |
IAction2<PluginConnection, Candidate> |
Returns: void
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:169
addOnRemoteDescription
▸ addOnRemoteDescription(value
: IAction2<PluginConnection, SessionDescription>): void
Parameters:
Name | Type |
---|---|
value |
IAction2<PluginConnection, SessionDescription> |
Returns: void
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:172
addOnSignallingStateChange
▸ addOnSignallingStateChange(value
: IAction1<PluginConnection>): void
Parameters:
Name | Type |
---|---|
value |
IAction1<PluginConnection> |
Returns: void
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:175
addOnStateChange
▸ addOnStateChange(value
: IAction1<PluginConnection>): void
Parameters:
Name | Type |
---|---|
value |
IAction1<PluginConnection> |
Returns: void
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:178
addRemoteCandidate
▸ addRemoteCandidate(remoteCandidate
: Candidate): Future<Candidate>
Parameters:
Name | Type |
---|---|
remoteCandidate |
Candidate |
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:181
addToWebSocketConnection
▸ addToWebSocketConnection(openArgs
: WssServiceOpenArgs): void
Parameters:
Name | Type |
---|---|
openArgs |
WssServiceOpenArgs |
Returns: void
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:421
close
▸ close(): boolean
Returns: boolean
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:192
createAnswer
▸ createAnswer(): Future<SessionDescription>
Returns: Future<SessionDescription>
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:195
createOffer
▸ createOffer(): Future<SessionDescription>
Returns: Future<SessionDescription>
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:206
getAudioStream
▸ getAudioStream(): PluginAudioStream
Returns: PluginAudioStream
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:226
getAudioStreams
▸ getAudioStreams(): PluginAudioStream[]
Returns: PluginAudioStream[]
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:229
getBundlePolicy
▸ getBundlePolicy(): BundlePolicy
Returns: BundlePolicy
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:274
getCanonicalName
▸ getCanonicalName(): string
Returns: string
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:286
getDataStream
▸ getDataStream(): PluginDataStream
Returns: PluginDataStream
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:250
getDataStreams
▸ getDataStreams(): PluginDataStream[]
Returns: PluginDataStream[]
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:253
getDeadStreamTimeout
▸ getDeadStreamTimeout(): number
Returns: number
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:262
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
getError
▸ getError(): Error
Returns: Error
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:268
getExternalId
▸ getExternalId(): string
Returns: string
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:265
getGatheringState
▸ getGatheringState(): IceGatheringState
Returns: IceGatheringState
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:330
getHasAudio
▸ getHasAudio(): boolean
Returns: boolean
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:217
getHasData
▸ getHasData(): boolean
Returns: boolean
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:223
getHasVideo
▸ getHasVideo(): boolean
Returns: boolean
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:220
getIceConnectionState
▸ getIceConnectionState(): IceConnectionState
Returns: IceConnectionState
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:327
getIceGatherPolicy
▸ getIceGatherPolicy(): IceGatherPolicy
Returns: IceGatherPolicy
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:271
getIceServer
▸ getIceServer(): IceServer
Returns: IceServer
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:277
getIceServers
▸ getIceServers(): IceServer[]
Returns: IceServer[]
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:280
getId
▸ getId(): string
Returns: string
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:283
getLegacyTimeout
▸ getLegacyTimeout(): boolean
Returns: boolean
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:321
getLocalDescription
▸ getLocalDescription(): SessionDescription
Returns: SessionDescription
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:289
getMediaProtocol
▸ getMediaProtocol(): MediaProtocol
Returns: MediaProtocol
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:140
getRemoteDescription
▸ getRemoteDescription(): SessionDescription
Returns: SessionDescription
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:292
getSignallingState
▸ getSignallingState(): SignallingState
Returns: SignallingState
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:295
getState
▸ getState(): ConnectionState
Returns: ConnectionState
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:298
getStats
▸ getStats(): Future<ConnectionStats>
Returns: Future<ConnectionStats>
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:301
getStreams
▸ getStreams(): PluginStream[]
Returns: PluginStream[]
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:312
getTieBreaker
▸ getTieBreaker(): string
Returns: string
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:315
getTimeout
▸ getTimeout(): number
Returns: number
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:318
getTrickleIcePolicy
▸ getTrickleIcePolicy(): TrickleIcePolicy
Returns: TrickleIcePolicy
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:324
getTypeString
▸ getTypeString(): string
Returns: string
Overrides: Dynamic
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:7
getVideoEnabledUpdateConnectionPolicy
▸ getVideoEnabledUpdateConnectionPolicy(): IFunction1<number, number>
Returns: IFunction1<number, number>
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:433
getVideoRetentionPolicy
▸ getVideoRetentionPolicy(): VideoRetentionPolicy
Returns: VideoRetentionPolicy
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:427
getVideoStream
▸ getVideoStream(): PluginVideoStream
Returns: PluginVideoStream
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:238
getVideoStreams
▸ getVideoStreams(): PluginVideoStream[]
Returns: PluginVideoStream[]
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:241
removeIceServer
▸ removeIceServer(iceServer
: IceServer): void
Parameters:
Name | Type |
---|---|
iceServer |
IceServer |
Returns: void
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:333
removeIceServers
▸ removeIceServers(iceServers
: IceServer[]): void
Parameters:
Name | Type |
---|---|
iceServers |
IceServer[] |
Returns: void
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:336
removeOnExternalIdChange
▸ removeOnExternalIdChange(value
: IAction2<string, string>): void
Parameters:
Name | Type |
---|---|
value |
IAction2<string, string> |
Returns: void
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:345
removeOnGatheringStateChange
▸ removeOnGatheringStateChange(value
: IAction1<PluginConnection>): void
Parameters:
Name | Type |
---|---|
value |
IAction1<PluginConnection> |
Returns: void
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:348
removeOnIceConnectionStateChange
▸ removeOnIceConnectionStateChange(value
: IAction1<PluginConnection>): void
Parameters:
Name | Type |
---|---|
value |
IAction1<PluginConnection> |
Returns: void
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:342
removeOnLocalCandidate
▸ removeOnLocalCandidate(value
: IAction2<PluginConnection, Candidate>): void
Parameters:
Name | Type |
---|---|
value |
IAction2<PluginConnection, Candidate> |
Returns: void
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:339
removeOnLocalDescription
▸ removeOnLocalDescription(value
: IAction2<PluginConnection, SessionDescription>): void
Parameters:
Name | Type |
---|---|
value |
IAction2<PluginConnection, SessionDescription> |
Returns: void
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:351
removeOnRemoteCandidate
▸ removeOnRemoteCandidate(value
: IAction2<PluginConnection, Candidate>): void
Parameters:
Name | Type |
---|---|
value |
IAction2<PluginConnection, Candidate> |
Returns: void
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:354
removeOnRemoteDescription
▸ removeOnRemoteDescription(value
: IAction2<PluginConnection, SessionDescription>): void
Parameters:
Name | Type |
---|---|
value |
IAction2<PluginConnection, SessionDescription> |
Returns: void
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:357
removeOnSignallingStateChange
▸ removeOnSignallingStateChange(value
: IAction1<PluginConnection>): void
Parameters:
Name | Type |
---|---|
value |
IAction1<PluginConnection> |
Returns: void
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:360
removeOnStateChange
▸ removeOnStateChange(value
: IAction1<PluginConnection>): void
Parameters:
Name | Type |
---|---|
value |
IAction1<PluginConnection> |
Returns: void
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:363
setBundlePolicy
▸ setBundlePolicy(value
: BundlePolicy): void
Parameters:
Name | Type |
---|---|
value |
BundlePolicy |
Returns: void
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:378
setDeadStreamTimeout
▸ setDeadStreamTimeout(value
: number): void
Parameters:
Name | Type |
---|---|
value |
number |
Returns: void
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:366
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
setError
▸ setError(value
: Error): void
Parameters:
Name | Type |
---|---|
value |
Error |
Returns: void
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:372
setExternalId
▸ setExternalId(value
: string): void
Parameters:
Name | Type |
---|---|
value |
string |
Returns: void
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:369
setIceGatherPolicy
▸ setIceGatherPolicy(value
: IceGatherPolicy): void
Parameters:
Name | Type |
---|---|
value |
IceGatherPolicy |
Returns: void
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:375
setIceServer
▸ setIceServer(value
: IceServer): void
Parameters:
Name | Type |
---|---|
value |
IceServer |
Returns: void
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:381
setIceServers
▸ setIceServers(value
: IceServer[]): void
Parameters:
Name | Type |
---|---|
value |
IceServer[] |
Returns: void
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:384
setLegacyTimeout
▸ setLegacyTimeout(value
: boolean): void
Parameters:
Name | Type |
---|---|
value |
boolean |
Returns: void
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:387
setLocalDescription
▸ setLocalDescription(localDescription
: SessionDescription): Future<SessionDescription>
Parameters:
Name | Type |
---|---|
localDescription |
SessionDescription |
Returns: Future<SessionDescription>
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:393
setRemoteDescription
▸ setRemoteDescription(remoteDescription
: SessionDescription): Future<SessionDescription>
Parameters:
Name | Type |
---|---|
remoteDescription |
SessionDescription |
Returns: Future<SessionDescription>
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:404
setState
▸ setState(state
: ConnectionState): void
Parameters:
Name | Type |
---|---|
state |
ConnectionState |
Returns: void
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:144
setTieBreaker
▸ setTieBreaker(value
: string): void
Parameters:
Name | Type |
---|---|
value |
string |
Returns: void
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:390
setTimeout
▸ setTimeout(value
: number): void
Parameters:
Name | Type |
---|---|
value |
number |
Returns: void
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:415
setTrickleIcePolicy
▸ setTrickleIcePolicy(value
: TrickleIcePolicy): void
Parameters:
Name | Type |
---|---|
value |
TrickleIcePolicy |
Returns: void
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:418
setVideoEnabledUpdateConnectionPolicy
▸ setVideoEnabledUpdateConnectionPolicy(value
: IFunction1<number, number>): void
Parameters:
Name | Type |
---|---|
value |
IFunction1<number, number> |
Returns: void
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:436
setVideoRetentionPolicy
▸ setVideoRetentionPolicy(value
: VideoRetentionPolicy): void
Parameters:
Name | Type |
---|---|
value |
VideoRetentionPolicy |
Returns: void
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:430
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
updateWebSocketConnection
▸ updateWebSocketConnection(config
: ConnectionConfig, promise
: Promise<object>): void
Parameters:
Name | Type |
---|---|
config |
ConnectionConfig |
promise |
Promise<object> |
Returns: void
Implementation of: IInternalConnection
Defined in: Generated/TypeScript/fm.liveswitch/PluginConnection.ts:424