Class Downlink

Hierarchy

Downlink

Index

Constructors

constructor

Properties

Accessors

session

Methods

Constructors

constructor

new Downlink(context: DownlinkContext, owner: null | DownlinkOwner, init?: DownlinkInit, hostUri?: Uri, nodeUri?: Uri, laneUri?: Uri, prio?: number, rate?: number, body?: Value, flags?: number, observers?: DownlinkObserver | readonly DownlinkObserver[]): Downlink

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:49
Parameters
- context: DownlinkContext
- owner: null | DownlinkOwner
- Optional init: DownlinkInit
- Optional hostUri: Uri
- Optional nodeUri: Uri
- Optional laneUri: Uri
- Optional prio: number
- Optional rate: number
- Optional body: Value
- Optional flags: number
- Optional observers: DownlinkObserver | readonly DownlinkObserver[]
Returns Downlink

Properties

Readonly context

context: DownlinkContext

Readonly flags

flags: number

Readonly model

model: null | DownlinkModel

Readonly observers

observers: readonly DownlinkObserver[]

Readonly ownBody

ownBody: Value

Readonly ownHostUri

ownHostUri: Uri

Readonly ownLaneUri

ownLaneUri: Uri

Readonly ownNodeUri

ownNodeUri: Uri

Readonly ownPrio

ownPrio: number

Readonly ownRate

ownRate: number

Readonly owner

owner: null | DownlinkOwner

Readonly Abstract type

type: DownlinkType

Accessors

session

get session(): Value

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:98
Returns Value

Methods

body

body(): Value
body(body: AnyValue): Downlink

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:74
Returns Value
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:75
Parameters
- body: AnyValue
Returns Downlink

close

close(): void

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:112
Returns void

closeUp

closeUp(): void

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:114
Returns void

command

command(body: AnyValue): void

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:110
Parameters
- body: AnyValue
Returns void

Protected Abstract copy

copy(context: DownlinkContext, owner: null | DownlinkOwner, hostUri: Uri, nodeUri: Uri, laneUri: Uri, prio: number, rate: number, body: Value, flags: number, observers: readonly DownlinkObserver[]): Downlink

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:63
Parameters
- context: DownlinkContext
- owner: null | DownlinkOwner
- hostUri: Uri
- nodeUri: Uri
- laneUri: Uri
- prio: number
- rate: number
- body: Value
- flags: number
- observers: readonly DownlinkObserver[]
Returns Downlink

didClose

didClose(didClose: DownlinkDidClose): Downlink

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:92
Parameters
- didClose: DownlinkDidClose
Returns Downlink

didConnect

didConnect(didConnect: DownlinkDidConnect): Downlink

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:90
Parameters
- didConnect: DownlinkDidConnect
Returns Downlink

didDisconnect

didDisconnect(didDisconnect: DownlinkDidDisconnect): Downlink

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:91
Parameters
- didDisconnect: DownlinkDidDisconnect
Returns Downlink

didFail

didFail(didFail: DownlinkDidFail): Downlink

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:93
Parameters
- didFail: DownlinkDidFail
Returns Downlink

didLink

didLink(didLink: DownlinkDidLink): Downlink

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:85
Parameters
- didLink: DownlinkDidLink
Returns Downlink

didSync

didSync(didSync: DownlinkDidSync): Downlink

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:87
Parameters
- didSync: DownlinkDidSync
Returns Downlink

didUnlink

didUnlink(didUnlink: DownlinkDidUnlink): Downlink

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:89
Parameters
- didUnlink: DownlinkDidUnlink
Returns Downlink

hostDidConnect

hostDidConnect(): void

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:107
Returns void

hostDidDisconnect

hostDidDisconnect(): void

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:108
Returns void

hostDidFail

hostDidFail(error: unknown): void

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:109
Parameters
- error: unknown
Returns void

hostUri

hostUri(): Uri
hostUri(hostUri: AnyUri): Downlink

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:64
Returns Uri
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:65
Parameters
- hostUri: AnyUri
Returns Downlink

isAuthenticated

isAuthenticated(): boolean

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:95
Returns boolean

isConnected

isConnected(): boolean

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:94
Returns boolean

isLinked

isLinked(): boolean

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:96
Returns boolean

isSynced

isSynced(): boolean

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:97
Returns boolean

keepLinked

keepLinked(): boolean
keepLinked(keepLinked: boolean): Downlink

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:76
Returns boolean
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:77
Parameters
- keepLinked: boolean
Returns Downlink

keepSynced

keepSynced(): boolean
keepSynced(keepSynced: boolean): Downlink

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:78
Returns boolean
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:79
Parameters
- keepSynced: boolean
Returns Downlink

laneUri

laneUri(): Uri
laneUri(laneUri: AnyUri): Downlink

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:68
Returns Uri
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:69
Parameters
- laneUri: AnyUri
Returns Downlink

nodeUri

nodeUri(): Uri
nodeUri(nodeUri: AnyUri): Downlink

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:66
Returns Uri
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:67
Parameters
- nodeUri: AnyUri
Returns Downlink

observe

observe(observer: DownlinkObserver): Downlink

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:80
Parameters
- observer: DownlinkObserver
Returns Downlink

onCommand

onCommand(onCommand: DownlinkOnCommand): Downlink

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:83
Parameters
- onCommand: DownlinkOnCommand
Returns Downlink

onCommandMessage

onCommandMessage(body: Value): void

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:100
Parameters
- body: Value
Returns void

onEvent

onEvent(onEvent: DownlinkOnEvent): Downlink

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:82
Parameters
- onEvent: DownlinkOnEvent
Returns Downlink

onEventMessage

onEventMessage(message: EventMessage): void

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:99
Parameters
- message: EventMessage
Returns void

onLinkRequest

onLinkRequest(request?: LinkRequest): void

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:101
Parameters
- Optional request: LinkRequest
Returns void

onLinkedResponse

onLinkedResponse(response?: LinkedResponse): void

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:102
Parameters
- Optional response: LinkedResponse
Returns void

onSyncRequest

onSyncRequest(request?: SyncRequest): void

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:103
Parameters
- Optional request: SyncRequest
Returns void

onSyncedResponse

onSyncedResponse(response?: SyncedResponse): void

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:104
Parameters
- Optional response: SyncedResponse
Returns void

onUnlinkRequest

onUnlinkRequest(request?: UnlinkRequest): void

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:105
Parameters
- Optional request: UnlinkRequest
Returns void

onUnlinkedResponse

onUnlinkedResponse(response?: UnlinkedResponse): void

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:106
Parameters
- Optional response: UnlinkedResponse
Returns void

Abstract open

open(): Downlink

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:111
Returns Downlink

openUp

openUp(host: Host): void

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:113
Parameters
- host: Host
Returns void

prio

prio(): number
prio(prio: number): Downlink

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:70
Returns number
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:71
Parameters
- prio: number
Returns Downlink

rate

rate(): number
rate(rate: number): Downlink

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:72
Returns number
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:73
Parameters
- rate: number
Returns Downlink

unobserve

unobserve(observer: unknown): Downlink

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:81
Parameters
- observer: unknown
Returns Downlink

willLink

willLink(willLink: DownlinkWillLink): Downlink

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:84
Parameters
- willLink: DownlinkWillLink
Returns Downlink

willSync

willSync(willSync: DownlinkWillSync): Downlink

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:86
Parameters
- willSync: DownlinkWillSync
Returns Downlink

willUnlink

willUnlink(willUnlink: DownlinkWillUnlink): Downlink

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:88
Parameters
- willUnlink: DownlinkWillUnlink
Returns Downlink

Static initForm

initForm(): Form<undefined | DownlinkInit, never>

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/Downlink.d.ts:115
Returns Form<undefined | DownlinkInit, never>

Generated using TypeDoc