Class EventDownlink

Hierarchy

Downlink
- EventDownlink

Index

Constructors

constructor

Properties

Accessors

session
type

Methods

Constructors

constructor

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

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

Properties

Readonly context

context: DownlinkContext

Readonly flags

flags: number

Readonly model

model: null | EventDownlinkModel

Readonly observers

observers: readonly EventDownlinkObserver[]

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

Accessors

session

get session(): Value

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

type

get type(): DownlinkType

- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/EventDownlink.d.ts:15
Returns DownlinkType

Methods

body

body(): Value
body(body: AnyValue): EventDownlink

Inherited from Downlink.body
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/EventDownlink.d.ts:31
Returns Value
Inherited from Downlink.body
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/EventDownlink.d.ts:32
Parameters
- body: AnyValue
Returns EventDownlink

close

close(): void

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

closeUp

closeUp(): void

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

command

command(body: AnyValue): void

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

Protected copy

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

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

didClose

didClose(didClose: DownlinkDidClose): EventDownlink

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

didConnect

didConnect(didConnect: DownlinkDidConnect): EventDownlink

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

didDisconnect

didDisconnect(didDisconnect: DownlinkDidDisconnect): EventDownlink

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

didFail

didFail(didFail: DownlinkDidFail): EventDownlink

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

didLink

didLink(didLink: DownlinkDidLink): EventDownlink

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

didSync

didSync(didSync: DownlinkDidSync): EventDownlink

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

didUnlink

didUnlink(didUnlink: DownlinkDidUnlink): EventDownlink

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

hostDidConnect

hostDidConnect(): void

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

hostDidDisconnect

hostDidDisconnect(): void

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

hostDidFail

hostDidFail(error: unknown): void

Inherited from Downlink.hostDidFail
- 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): EventDownlink

Inherited from Downlink.hostUri
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/EventDownlink.d.ts:21
Returns Uri
Inherited from Downlink.hostUri
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/EventDownlink.d.ts:22
Parameters
- hostUri: AnyUri
Returns EventDownlink

isAuthenticated

isAuthenticated(): boolean

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

isConnected

isConnected(): boolean

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

isLinked

isLinked(): boolean

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

isSynced

isSynced(): boolean

Inherited from Downlink.isSynced
- 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): EventDownlink

Inherited from Downlink.keepLinked
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/EventDownlink.d.ts:33
Returns boolean
Inherited from Downlink.keepLinked
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/EventDownlink.d.ts:34
Parameters
- keepLinked: boolean
Returns EventDownlink

keepSynced

keepSynced(): boolean
keepSynced(keepSynced: boolean): EventDownlink

Inherited from Downlink.keepSynced
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/EventDownlink.d.ts:35
Returns boolean
Inherited from Downlink.keepSynced
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/EventDownlink.d.ts:36
Parameters
- keepSynced: boolean
Returns EventDownlink

laneUri

laneUri(): Uri
laneUri(laneUri: AnyUri): EventDownlink

Inherited from Downlink.laneUri
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/EventDownlink.d.ts:25
Returns Uri
Inherited from Downlink.laneUri
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/EventDownlink.d.ts:26
Parameters
- laneUri: AnyUri
Returns EventDownlink

nodeUri

nodeUri(): Uri
nodeUri(nodeUri: AnyUri): EventDownlink

Inherited from Downlink.nodeUri
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/EventDownlink.d.ts:23
Returns Uri
Inherited from Downlink.nodeUri
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/EventDownlink.d.ts:24
Parameters
- nodeUri: AnyUri
Returns EventDownlink

observe

observe(observer: EventDownlinkObserver): EventDownlink

Overrides Downlink.observe
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/EventDownlink.d.ts:17
Parameters
- observer: EventDownlinkObserver
Returns EventDownlink

onCommand

onCommand(onCommand: DownlinkOnCommand): EventDownlink

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

onCommandMessage

onCommandMessage(body: Value): void

Inherited from Downlink.onCommandMessage
- 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): EventDownlink

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

onEventMessage

onEventMessage(message: EventMessage): void

Inherited from Downlink.onEventMessage
- 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

Inherited from Downlink.onLinkRequest
- 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

Inherited from Downlink.onLinkedResponse
- 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

Inherited from Downlink.onSyncRequest
- 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

Inherited from Downlink.onSyncedResponse
- 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

Inherited from Downlink.onUnlinkRequest
- 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

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

open

open(): EventDownlink

Overrides Downlink.open
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/EventDownlink.d.ts:18
Returns EventDownlink

openUp

openUp(host: Host): void

Inherited from Downlink.openUp
- 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): EventDownlink

Inherited from Downlink.prio
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/EventDownlink.d.ts:27
Returns number
Inherited from Downlink.prio
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/EventDownlink.d.ts:28
Parameters
- prio: number
Returns EventDownlink

rate

rate(): number
rate(rate: number): EventDownlink

Inherited from Downlink.rate
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/EventDownlink.d.ts:29
Returns number
Inherited from Downlink.rate
- Defined in swim-system-js/swim-mesh-js/@swim/client/lib/main/downlink/EventDownlink.d.ts:30
Parameters
- rate: number
Returns EventDownlink

unobserve

unobserve(observer: unknown): EventDownlink

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

willLink

willLink(willLink: DownlinkWillLink): EventDownlink

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

willSync

willSync(willSync: DownlinkWillSync): EventDownlink

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

willUnlink

willUnlink(willUnlink: DownlinkWillUnlink): EventDownlink

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

Static initForm

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

Inherited from Downlink.initForm
- 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