Class HostRef

Hierarchy

BaseRef
- HostRef

Index

Constructors

constructor

Properties

Accessors

session

Constructors

constructor

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

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

Properties

Readonly context

context: RefContext

Readonly downlinks

downlinks: Downlink[]

Readonly host

host: null | Host

Readonly hostUri

hostUri: Uri

Readonly observers

observers: readonly WarpObserver[]

Accessors

session

get session(): Value

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/ref/BaseRef.d.ts:25
Returns Value

Methods

addDownlink

addDownlink(downlink: Downlink): void

Inherited from BaseRef.addDownlink
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/ref/BaseRef.d.ts:39
Parameters
- downlink: Downlink
Returns void

authenticate

authenticate(credentials: AnyValue): void

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

close

close(): void

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

closeUp

closeUp(): void

Inherited from BaseRef.closeUp
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/ref/BaseRef.d.ts:43
Returns void

command

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

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

didAuthenticate

didAuthenticate(didAuthenticate: WarpDidAuthenticate): HostRef

Inherited from BaseRef.didAuthenticate
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/ref/BaseRef.d.ts:47
Parameters
- didAuthenticate: WarpDidAuthenticate
Returns HostRef

didConnect

didConnect(didConnect: WarpDidConnect): HostRef

Inherited from BaseRef.didConnect
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/ref/BaseRef.d.ts:46
Parameters
- didConnect: WarpDidConnect
Returns HostRef

didDeauthenticate

didDeauthenticate(didDeauthenticate: WarpDidDeauthenticate): HostRef

Inherited from BaseRef.didDeauthenticate
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/ref/BaseRef.d.ts:48
Parameters
- didDeauthenticate: WarpDidDeauthenticate
Returns HostRef

didDisconnect

didDisconnect(didDisconnect: WarpDidDisconnect): HostRef

Inherited from BaseRef.didDisconnect
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/ref/BaseRef.d.ts:49
Parameters
- didDisconnect: WarpDidDisconnect
Returns HostRef

didFail

didFail(didFail: WarpDidFail): HostRef

Inherited from BaseRef.didFail
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/ref/BaseRef.d.ts:50
Parameters
- didFail: WarpDidFail
Returns HostRef

downlink

downlink(init?: EventDownlinkInit): EventDownlink

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

Overrides BaseRef.downlinkList
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/ref/HostRef.d.ts:18
Parameters
- Optional init: ListDownlinkInit<Value, AnyValue>
Returns ListDownlink<Value, AnyValue>
Overrides BaseRef.downlinkList
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/ref/HostRef.d.ts:19
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>

Overrides BaseRef.downlinkMap
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/ref/HostRef.d.ts:20
Parameters
- Optional init: MapDownlinkInit<Value, Value, AnyValue, AnyValue>
Returns MapDownlink<Value, Value, AnyValue, AnyValue>
Overrides BaseRef.downlinkMap
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/ref/HostRef.d.ts:21
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>

Overrides BaseRef.downlinkValue
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/ref/HostRef.d.ts:22
Parameters
- Optional init: ValueDownlinkInit<Value, AnyValue>
Returns ValueDownlink<Value, AnyValue>
Overrides BaseRef.downlinkValue
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/ref/HostRef.d.ts:23
Type parameters
- V
- VU = never
Parameters
- Optional init: ValueDownlinkInit<V, VU>
Returns ValueDownlink<V, VU>

hostDidAuthenticate

hostDidAuthenticate(body: Value, host: Host): void

Inherited from BaseRef.hostDidAuthenticate
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/ref/BaseRef.d.ts:52
Parameters
- body: Value
- host: Host
Returns void

hostDidConnect

hostDidConnect(host: Host): void

Inherited from BaseRef.hostDidConnect
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/ref/BaseRef.d.ts:51
Parameters
- host: Host
Returns void

hostDidDeauthenticate

hostDidDeauthenticate(body: Value, host: Host): void

Inherited from BaseRef.hostDidDeauthenticate
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/ref/BaseRef.d.ts:53
Parameters
- body: Value
- host: Host
Returns void

hostDidDisconnect

hostDidDisconnect(host: Host): void

Inherited from BaseRef.hostDidDisconnect
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/ref/BaseRef.d.ts:54
Parameters
- host: Host
Returns void

hostDidFail

hostDidFail(error: unknown, host: Host): void

Inherited from BaseRef.hostDidFail
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/ref/BaseRef.d.ts:55
Parameters
- error: unknown
- host: Host
Returns void

hostRef

hostRef(hostUri: AnyUri): HostRef

Overrides BaseRef.hostRef
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/ref/HostRef.d.ts:14
Parameters
- hostUri: AnyUri
Returns HostRef

isAuthenticated

isAuthenticated(): boolean

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

isConnected

isConnected(): boolean

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

laneRef

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

Overrides BaseRef.laneRef
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/ref/HostRef.d.ts:16
Parameters
- nodeUri: AnyUri
- laneUri: AnyUri
Returns LaneRef

nodeRef

nodeRef(nodeUri: AnyUri): NodeRef

Overrides BaseRef.nodeRef
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/ref/HostRef.d.ts:15
Parameters
- nodeUri: AnyUri
Returns NodeRef

observe

observe(observer: WarpObserver): HostRef

Inherited from BaseRef.observe
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/ref/BaseRef.d.ts:44
Parameters
- observer: WarpObserver
Returns HostRef

open

open(): void

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

removeDownlink

removeDownlink(downlink: Downlink): void

Inherited from BaseRef.removeDownlink
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/ref/BaseRef.d.ts:40
Parameters
- downlink: Downlink
Returns void

unobserve

unobserve(observer: unknown): HostRef

Inherited from BaseRef.unobserve
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/ref/BaseRef.d.ts:45
Parameters
- observer: unknown
Returns HostRef

Generated using TypeDoc