Class HostRef

Hierarchy

BaseRef
- HostRef

Implements

DownlinkOwner
WarpRef

Index

Constructors

constructor

Constructors

constructor

new HostRef(context: RefContext, hostUri: Uri): HostRef

Overrides BaseRef.constructor
- Defined in swim-mesh-js/@swim/client/main/ref/HostRef.ts:28
Parameters
- context: RefContext
- hostUri: Uri
Returns HostRef

Methods

authenticate

authenticate(credentials: AnyValue): void

Inherited from BaseRef.authenticate
- Defined in swim-mesh-js/@swim/client/main/ref/BaseRef.ts:68
Parameters
- credentials: AnyValue
Returns void

close

close(): void

Inherited from BaseRef.close
- Defined in swim-mesh-js/@swim/client/main/ref/BaseRef.ts:106
Returns void

command

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

- Defined in swim-mesh-js/@swim/client/main/ref/HostRef.ts:77
Parameters
- nodeUri: AnyUri
- laneUri: AnyUri
- body: AnyValue
Returns void

didAuthenticate

didAuthenticate(didAuthenticate: WarpDidAuthenticate): this

Implementation of WarpRef.didAuthenticate

Inherited from BaseRef.didAuthenticate
- Defined in swim-mesh-js/@swim/client/main/ref/BaseRef.ts:168
Parameters
- didAuthenticate: WarpDidAuthenticate
Returns this

didConnect

didConnect(didConnect: WarpDidConnect): this

Implementation of WarpRef.didConnect

Inherited from BaseRef.didConnect
- Defined in swim-mesh-js/@swim/client/main/ref/BaseRef.ts:164
Parameters
- didConnect: WarpDidConnect
Returns this

didDeauthenticate

didDeauthenticate(didDeauthenticate: WarpDidDeauthenticate): this

Implementation of WarpRef.didDeauthenticate

Inherited from BaseRef.didDeauthenticate
- Defined in swim-mesh-js/@swim/client/main/ref/BaseRef.ts:172
Parameters
- didDeauthenticate: WarpDidDeauthenticate
Returns this

didDisconnect

didDisconnect(didDisconnect: WarpDidDisconnect): this

Implementation of WarpRef.didDisconnect

Inherited from BaseRef.didDisconnect
- Defined in swim-mesh-js/@swim/client/main/ref/BaseRef.ts:176
Parameters
- didDisconnect: WarpDidDisconnect
Returns this

didFail

didFail(didFail: WarpDidFail): this

Implementation of WarpRef.didFail

Inherited from BaseRef.didFail
- Defined in swim-mesh-js/@swim/client/main/ref/BaseRef.ts:180
Parameters
- didFail: WarpDidFail
Returns this

downlink

downlink(init?: EventDownlinkInit): EventDownlink

Implementation of WarpRef.downlink

Overrides BaseRef.downlink
- Defined in swim-mesh-js/@swim/client/main/ref/HostRef.ts:55
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

Overrides BaseRef.downlinkList
- Defined in swim-mesh-js/@swim/client/main/ref/HostRef.ts:59
Parameters
- Optional init: ListDownlinkInit<Value, AnyValue>
Returns ListDownlink<Value, AnyValue>
Implementation of WarpRef.downlinkList

Overrides BaseRef.downlinkList
- Defined in swim-mesh-js/@swim/client/main/ref/HostRef.ts:60
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

Overrides BaseRef.downlinkMap
- Defined in swim-mesh-js/@swim/client/main/ref/HostRef.ts:65
Parameters
- Optional init: MapDownlinkInit<Value, Value, AnyValue, AnyValue>
Returns MapDownlink<Value, Value, AnyValue, AnyValue>
Implementation of WarpRef.downlinkMap

Overrides BaseRef.downlinkMap
- Defined in swim-mesh-js/@swim/client/main/ref/HostRef.ts:66
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

Overrides BaseRef.downlinkValue
- Defined in swim-mesh-js/@swim/client/main/ref/HostRef.ts:71
Parameters
- Optional init: ValueDownlinkInit<Value, AnyValue>
Returns ValueDownlink<Value, AnyValue>
Implementation of WarpRef.downlinkValue

Overrides BaseRef.downlinkValue
- Defined in swim-mesh-js/@swim/client/main/ref/HostRef.ts:72
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/ref/HostRef.ts:39
Parameters
- hostUri: AnyUri
Returns HostRef

hostUri

hostUri(): Uri

Overrides BaseRef.hostUri
- Defined in swim-mesh-js/@swim/client/main/ref/HostRef.ts:35
Returns Uri

isAuthenticated

isAuthenticated(): boolean

Inherited from BaseRef.isAuthenticated
- Defined in swim-mesh-js/@swim/client/main/ref/BaseRef.ts:60
Returns boolean

isConnected

isConnected(): boolean

Inherited from BaseRef.isConnected
- Defined in swim-mesh-js/@swim/client/main/ref/BaseRef.ts:56
Returns boolean

laneRef

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

- Defined in swim-mesh-js/@swim/client/main/ref/HostRef.ts:49
Parameters
- nodeUri: AnyUri
- laneUri: AnyUri
Returns LaneRef

nodeRef

nodeRef(nodeUri: AnyUri): NodeRef

- Defined in swim-mesh-js/@swim/client/main/ref/HostRef.ts:44
Parameters
- nodeUri: AnyUri
Returns NodeRef

observe

observe(observer: WarpObserver): this

Implementation of WarpRef.observe

Inherited from BaseRef.observe
- Defined in swim-mesh-js/@swim/client/main/ref/BaseRef.ts:119
Parameters
- observer: WarpObserver
Returns this

open

open(): void

Inherited from BaseRef.open
- Defined in swim-mesh-js/@swim/client/main/ref/BaseRef.ts:102
Returns void

session

session(): Value

Inherited from BaseRef.session
- Defined in swim-mesh-js/@swim/client/main/ref/BaseRef.ts:64
Returns Value

unobserve

unobserve(observer: unknown): this

Implementation of WarpRef.unobserve

Inherited from BaseRef.unobserve
- Defined in swim-mesh-js/@swim/client/main/ref/BaseRef.ts:131
Parameters
- observer: unknown
Returns this