Class WarpClient

Hierarchy

WarpClient

Implements

Index

Constructors

constructor

Constructors

constructor

new WarpClient(options?: WarpClientOptions): WarpClient

- Defined in swim-system-js/swim-mesh-js/@swim/client/main/WarpClient.ts:46
Parameters
- options: WarpClientOptions = {}
Returns WarpClient

Methods

authenticate

authenticate(hostUri: AnyUri, credentials: AnyValue): void

Implementation of RefContext.authenticate
- Defined in swim-system-js/swim-mesh-js/@swim/client/main/WarpClient.ts:346
Parameters
- hostUri: AnyUri
- credentials: AnyValue
Returns void

close

close(): void

- Defined in swim-system-js/swim-mesh-js/@swim/client/main/WarpClient.ts:372
Returns void

command

command(hostUri: AnyUri, nodeUri: AnyUri, laneUri: AnyUri, body: AnyValue): void
command(nodeUri: AnyUri, laneUri: AnyUri, body: AnyValue): void

Implementation of RefContext.command
- Defined in swim-system-js/swim-mesh-js/@swim/client/main/WarpClient.ts:353
Parameters
- hostUri: AnyUri
- nodeUri: AnyUri
- laneUri: AnyUri
- body: AnyValue
Returns void
Implementation of RefContext.command
- Defined in swim-system-js/swim-mesh-js/@swim/client/main/WarpClient.ts:354
Parameters
- nodeUri: AnyUri
- laneUri: AnyUri
- body: AnyValue
Returns void

didAuthenticate

didAuthenticate(didAuthenticate: WarpDidAuthenticate): WarpClient

Implementation of WarpRef.didAuthenticate
- Defined in swim-system-js/swim-mesh-js/@swim/client/main/WarpClient.ts:461
Parameters
- didAuthenticate: WarpDidAuthenticate
Returns WarpClient

didConnect

didConnect(didConnect: WarpDidConnect): WarpClient

Implementation of WarpRef.didConnect
- Defined in swim-system-js/swim-mesh-js/@swim/client/main/WarpClient.ts:457
Parameters
- didConnect: WarpDidConnect
Returns WarpClient

didDeauthenticate

didDeauthenticate(didDeauthenticate: WarpDidDeauthenticate): WarpClient

Implementation of WarpRef.didDeauthenticate
- Defined in swim-system-js/swim-mesh-js/@swim/client/main/WarpClient.ts:465
Parameters
- didDeauthenticate: WarpDidDeauthenticate
Returns WarpClient

didDisconnect

didDisconnect(didDisconnect: WarpDidDisconnect): WarpClient

Implementation of WarpRef.didDisconnect
- Defined in swim-system-js/swim-mesh-js/@swim/client/main/WarpClient.ts:469
Parameters
- didDisconnect: WarpDidDisconnect
Returns WarpClient

didFail

didFail(didFail: WarpDidFail): WarpClient

Implementation of WarpRef.didFail
- Defined in swim-system-js/swim-mesh-js/@swim/client/main/WarpClient.ts:473
Parameters
- didFail: WarpDidFail
Returns WarpClient

downlink

downlink(init?: EventDownlinkInit): EventDownlink

Implementation of WarpRef.downlink
- Defined in swim-system-js/swim-mesh-js/@swim/client/main/WarpClient.ts:274
Parameters
- Optional init: EventDownlinkInit
Returns EventDownlink

downlinkList

downlinkList(init?: ListDownlinkInit<Value, AnyValue>): ListDownlink<Value, AnyValue>
downlinkList<V, VU>(init?: ListDownlinkInit<V, VU>): ListDownlink<V, VU>

Implementation of WarpRef.downlinkList
- Defined in swim-system-js/swim-mesh-js/@swim/client/main/WarpClient.ts:278
Parameters
- Optional init: ListDownlinkInit<Value, AnyValue>
Returns ListDownlink<Value, AnyValue>
Implementation of WarpRef.downlinkList
- Defined in swim-system-js/swim-mesh-js/@swim/client/main/WarpClient.ts:279
Type parameters
- V
- VU = never
Parameters
- Optional init: ListDownlinkInit<V, VU>
Returns ListDownlink<V, VU>

downlinkMap

downlinkMap(init?: MapDownlinkInit<Value, Value, AnyValue, AnyValue>): MapDownlink<Value, Value, AnyValue, AnyValue>
downlinkMap<K, V, KU, VU>(init?: MapDownlinkInit<K, V, KU, VU>): MapDownlink<K, V, KU, VU>

Implementation of WarpRef.downlinkMap
- Defined in swim-system-js/swim-mesh-js/@swim/client/main/WarpClient.ts:284
Parameters
- Optional init: MapDownlinkInit<Value, Value, AnyValue, AnyValue>
Returns MapDownlink<Value, Value, AnyValue, AnyValue>
Implementation of WarpRef.downlinkMap
- Defined in swim-system-js/swim-mesh-js/@swim/client/main/WarpClient.ts:285
Type parameters
- K
- V
- KU = never
- VU = never
Parameters
- Optional init: MapDownlinkInit<K, V, KU, VU>
Returns MapDownlink<K, V, KU, VU>

downlinkValue

downlinkValue(init?: ValueDownlinkInit<Value, AnyValue>): ValueDownlink<Value, AnyValue>
downlinkValue<V, VU>(init?: ValueDownlinkInit<V, VU>): ValueDownlink<V, VU>

Implementation of WarpRef.downlinkValue
- Defined in swim-system-js/swim-mesh-js/@swim/client/main/WarpClient.ts:290
Parameters
- Optional init: ValueDownlinkInit<Value, AnyValue>
Returns ValueDownlink<Value, AnyValue>
Implementation of WarpRef.downlinkValue
- Defined in swim-system-js/swim-mesh-js/@swim/client/main/WarpClient.ts:291
Type parameters
- V
- VU = never
Parameters
- Optional init: ValueDownlinkInit<V, VU>
Returns ValueDownlink<V, VU>

hostRef

hostRef(hostUri: AnyUri): HostRef

Implementation of WarpRef.hostRef
- Defined in swim-system-js/swim-mesh-js/@swim/client/main/WarpClient.ts:311
Parameters
- hostUri: AnyUri
Returns HostRef

isOnline

isOnline(): boolean
isOnline(online: boolean): WarpClient

Implementation of HostContext.isOnline
- Defined in swim-system-js/swim-mesh-js/@swim/client/main/WarpClient.ts:113
Returns boolean
Implementation of HostContext.isOnline
- Defined in swim-system-js/swim-mesh-js/@swim/client/main/WarpClient.ts:114
Parameters
- online: boolean
Returns WarpClient

keepOnline

keepOnline(): boolean
keepOnline(keepOnline: boolean): WarpClient

- Defined in swim-system-js/swim-mesh-js/@swim/client/main/WarpClient.ts:135
Returns boolean
- Defined in swim-system-js/swim-mesh-js/@swim/client/main/WarpClient.ts:136
Parameters
- keepOnline: boolean
Returns WarpClient

laneRef

laneRef(hostUri: AnyUri, nodeUri: AnyUri, laneUri: AnyUri): LaneRef
laneRef(nodeUri: AnyUri, laneUri: AnyUri): LaneRef

Implementation of WarpRef.laneRef
- Defined in swim-system-js/swim-mesh-js/@swim/client/main/WarpClient.ts:330
Parameters
- hostUri: AnyUri
- nodeUri: AnyUri
- laneUri: AnyUri
Returns LaneRef
Implementation of WarpRef.laneRef
- Defined in swim-system-js/swim-mesh-js/@swim/client/main/WarpClient.ts:331
Parameters
- nodeUri: AnyUri
- laneUri: AnyUri
Returns LaneRef

nodeRef

nodeRef(hostUri: AnyUri, nodeUri: AnyUri): NodeRef
nodeRef(nodeUri: AnyUri): NodeRef

Implementation of WarpRef.nodeRef
- Defined in swim-system-js/swim-mesh-js/@swim/client/main/WarpClient.ts:316
Parameters
- hostUri: AnyUri
- nodeUri: AnyUri
Returns NodeRef
Implementation of WarpRef.nodeRef
- Defined in swim-system-js/swim-mesh-js/@swim/client/main/WarpClient.ts:317
Parameters
- nodeUri: AnyUri
Returns NodeRef

observe

observe(observer: WarpObserver): WarpClient

Implementation of WarpRef.observe
- Defined in swim-system-js/swim-mesh-js/@swim/client/main/WarpClient.ts:407
Parameters
- observer: WarpObserver
Returns WarpClient

Protected onOffline

onOffline(event: Event): void

- Defined in swim-system-js/swim-mesh-js/@swim/client/main/WarpClient.ts:165
Parameters
- event: Event
Returns void

Protected onOnline

onOnline(event: Event): void

- Defined in swim-system-js/swim-mesh-js/@swim/client/main/WarpClient.ts:161
Parameters
- event: Event
Returns void

unobserve

unobserve(observer: unknown): WarpClient

Implementation of WarpRef.unobserve
- Defined in swim-system-js/swim-mesh-js/@swim/client/main/WarpClient.ts:416
Parameters
- observer: unknown
Returns WarpClient

Protected watchOnline

watchOnline(keepOnline: boolean): void

- Defined in swim-system-js/swim-mesh-js/@swim/client/main/WarpClient.ts:149
Parameters
- keepOnline: boolean
Returns void

Generated using TypeDoc