Class WarpClient

Hierarchy

WarpClient

Implements

HostContext
RefContext
WarpRef

Index

Constructors

constructor

Constructors

constructor

new WarpClient(options?: WarpClientOptions): WarpClient

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

Methods

authenticate

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

- Defined in swim-mesh-js/@swim/client/main/WarpClient.ts:300
Parameters
- hostUri: AnyUri
- credentials: AnyValue
Returns void

close

close(): void

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

command

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

- Defined in swim-mesh-js/@swim/client/main/WarpClient.ts:307
Parameters
- hostUri: AnyUri
- nodeUri: AnyUri
- laneUri: AnyUri
- body: AnyValue
Returns void
- Defined in swim-mesh-js/@swim/client/main/WarpClient.ts:308
Parameters
- nodeUri: AnyUri
- laneUri: AnyUri
- body: AnyValue
Returns void

didAuthenticate

didAuthenticate(didAuthenticate: WarpDidAuthenticate): this

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

didConnect

didConnect(didConnect: WarpDidConnect): this

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

didDeauthenticate

didDeauthenticate(didDeauthenticate: WarpDidDeauthenticate): this

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

didDisconnect

didDisconnect(didDisconnect: WarpDidDisconnect): this

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

didFail

didFail(didFail: WarpDidFail): this

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

downlink

downlink(init?: EventDownlinkInit): EventDownlink

Implementation of WarpRef.downlink
- Defined in swim-mesh-js/@swim/client/main/WarpClient.ts:229
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-mesh-js/@swim/client/main/WarpClient.ts:233
Parameters
- Optional init: ListDownlinkInit<Value, AnyValue>
Returns ListDownlink<Value, AnyValue>
Implementation of WarpRef.downlinkList
- Defined in swim-mesh-js/@swim/client/main/WarpClient.ts:234
Type parameters
- V: VU
- VU
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-mesh-js/@swim/client/main/WarpClient.ts:239
Parameters
- Optional init: MapDownlinkInit<Value, Value, AnyValue, AnyValue>
Returns MapDownlink<Value, Value, AnyValue, AnyValue>
Implementation of WarpRef.downlinkMap
- Defined in swim-mesh-js/@swim/client/main/WarpClient.ts:240
Type parameters
- K: KU
- V: VU
- KU
- VU
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-mesh-js/@swim/client/main/WarpClient.ts:245
Parameters
- Optional init: ValueDownlinkInit<Value, AnyValue>
Returns ValueDownlink<Value, AnyValue>
Implementation of WarpRef.downlinkValue
- Defined in swim-mesh-js/@swim/client/main/WarpClient.ts:246
Type parameters
- V: VU
- VU
Parameters
- Optional init: ValueDownlinkInit<V, VU>
Returns ValueDownlink<V, VU>

hostRef

hostRef(hostUri: AnyUri): HostRef

- Defined in swim-mesh-js/@swim/client/main/WarpClient.ts:265
Parameters
- hostUri: AnyUri
Returns HostRef

isOnline

isOnline(): boolean
isOnline(online: boolean): this

- Defined in swim-mesh-js/@swim/client/main/WarpClient.ts:78
Returns boolean
- Defined in swim-mesh-js/@swim/client/main/WarpClient.ts:79
Parameters
- online: boolean
Returns this

keepOnline

keepOnline(): boolean
keepOnline(keepOnline: boolean): this

- Defined in swim-mesh-js/@swim/client/main/WarpClient.ts:98
Returns boolean
- Defined in swim-mesh-js/@swim/client/main/WarpClient.ts:99
Parameters
- keepOnline: boolean
Returns this

laneRef

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

- Defined in swim-mesh-js/@swim/client/main/WarpClient.ts:284
Parameters
- hostUri: AnyUri
- nodeUri: AnyUri
- laneUri: AnyUri
Returns LaneRef
- Defined in swim-mesh-js/@swim/client/main/WarpClient.ts:285
Parameters
- nodeUri: AnyUri
- laneUri: AnyUri
Returns LaneRef

nodeRef

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

- Defined in swim-mesh-js/@swim/client/main/WarpClient.ts:270
Parameters
- hostUri: AnyUri
- nodeUri: AnyUri
Returns NodeRef
- Defined in swim-mesh-js/@swim/client/main/WarpClient.ts:271
Parameters
- nodeUri: AnyUri
Returns NodeRef

observe

observe(observer: WarpObserver): this

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

Protected onOffline

onOffline(event: Event): void

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

Protected onOnline

onOnline(event: Event): void

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

unobserve

unobserve(observer: unknown): this

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

Protected watchOnline

watchOnline(keepOnline: boolean): void

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