Class BaseRef

Hierarchy

BaseRef
- HostRef
- NodeRef
- LaneRef

Implements

Index

Constructors

constructor

Properties

Accessors

session

Constructors

constructor

new BaseRef(context: RefContext): BaseRef

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/ref/BaseRef.d.ts:16
Parameters
- context: RefContext
Returns BaseRef

Properties

Readonly context

context: RefContext

Readonly downlinks

downlinks: Downlink[]

Readonly host

host: null | Host

Readonly Abstract 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

Implementation of DownlinkOwner.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

- 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

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

closeUp

closeUp(): void

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

didAuthenticate

didAuthenticate(didAuthenticate: WarpDidAuthenticate): BaseRef

Implementation of WarpRef.didAuthenticate
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/ref/BaseRef.d.ts:47
Parameters
- didAuthenticate: WarpDidAuthenticate
Returns BaseRef

didConnect

didConnect(didConnect: WarpDidConnect): BaseRef

Implementation of WarpRef.didConnect
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/ref/BaseRef.d.ts:46
Parameters
- didConnect: WarpDidConnect
Returns BaseRef

didDeauthenticate

didDeauthenticate(didDeauthenticate: WarpDidDeauthenticate): BaseRef

Implementation of WarpRef.didDeauthenticate
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/ref/BaseRef.d.ts:48
Parameters
- didDeauthenticate: WarpDidDeauthenticate
Returns BaseRef

didDisconnect

didDisconnect(didDisconnect: WarpDidDisconnect): BaseRef

Implementation of WarpRef.didDisconnect
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/ref/BaseRef.d.ts:49
Parameters
- didDisconnect: WarpDidDisconnect
Returns BaseRef

didFail

didFail(didFail: WarpDidFail): BaseRef

Implementation of WarpRef.didFail
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/ref/BaseRef.d.ts:50
Parameters
- didFail: WarpDidFail
Returns BaseRef

Abstract downlink

downlink(init?: EventDownlinkInit): EventDownlink

Implementation of WarpRef.downlink
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/ref/BaseRef.d.ts:27
Parameters
- Optional init: EventDownlinkInit
Returns EventDownlink

Abstract 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/lib/main/ref/BaseRef.d.ts:28
Parameters
- Optional init: ListDownlinkInit<Value, AnyValue>
Returns ListDownlink<Value, AnyValue>
Implementation of WarpRef.downlinkList
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/ref/BaseRef.d.ts:29
Type parameters
- V
- VU = never
Parameters
- Optional init: ListDownlinkInit<V, VU>
Returns ListDownlink<V, VU>

Abstract 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/lib/main/ref/BaseRef.d.ts:30
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/lib/main/ref/BaseRef.d.ts:31
Type parameters
- K
- V
- KU = never
- VU = never
Parameters
- Optional init: MapDownlinkInit<K, V, KU, VU>
Returns MapDownlink<K, V, KU, VU>

Abstract 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/lib/main/ref/BaseRef.d.ts:32
Parameters
- Optional init: ValueDownlinkInit<Value, AnyValue>
Returns ValueDownlink<Value, AnyValue>
Implementation of WarpRef.downlinkValue
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/ref/BaseRef.d.ts:33
Type parameters
- V
- VU = never
Parameters
- Optional init: ValueDownlinkInit<V, VU>
Returns ValueDownlink<V, VU>

hostDidAuthenticate

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

- 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

- 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

- 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

- 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

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

Abstract hostRef

hostRef(hostUri: AnyUri): HostRef

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

isAuthenticated

isAuthenticated(): boolean

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

isConnected

isConnected(): boolean

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

Abstract 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/lib/main/ref/BaseRef.d.ts:37
Parameters
- hostUri: AnyUri
- nodeUri: AnyUri
- laneUri: AnyUri
Returns LaneRef
Implementation of WarpRef.laneRef
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/ref/BaseRef.d.ts:38
Parameters
- nodeUri: AnyUri
- laneUri: AnyUri
Returns LaneRef

Abstract 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/lib/main/ref/BaseRef.d.ts:35
Parameters
- hostUri: AnyUri
- nodeUri: AnyUri
Returns NodeRef
Implementation of WarpRef.nodeRef
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/ref/BaseRef.d.ts:36
Parameters
- nodeUri: AnyUri
Returns NodeRef

observe

observe(observer: WarpObserver): BaseRef

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

open

open(): void

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

removeDownlink

removeDownlink(downlink: Downlink): void

Implementation of DownlinkOwner.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): BaseRef

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

Generated using TypeDoc