Search
Preparing search index...
The search index is not available
Swim Toolkit
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
Swim Toolkit
@swim/model
ModelEventDownlink
Interface ModelEventDownlink<M>
Type parameters
M
:
ModelDownlinkContext
Hierarchy
ModelDownlink
<
M
>
ModelEventDownlink
Index
Properties
consume
downlink
downlink
Consumers
downlink
Flags
name
own
Body
own
Host
Uri
own
Lane
Uri
own
Node
Uri
own
Prio
own
Rate
own
Warp
owner
Methods
add
Downlink
Consumer
bind
Downlink
body
create
Downlink
did
Add
Downlink
Consumer
did
Mount
did
Remove
Downlink
Consumer
did
Start
Consuming
did
Stop
Consuming
did
Unmount
host
Uri
init
Body
init
Downlink
init
Host
Uri
init
Lane
Uri
init
Node
Uri
init
Prio
init
Rate
is
Consuming
is
Mounted
lane
Uri
link
mount
node
Uri
on
Add
Downlink
Consumer
on
Mount
on
Remove
Downlink
Consumer
on
Start
Consuming
on
Stop
Consuming
on
Unmount
prio
rate
reconcile
relink
remove
Downlink
Consumer
set
Downlink
Flags
start
Consuming
stop
Consuming
unlink
unmount
warp
will
Add
Downlink
Consumer
will
Mount
will
Remove
Downlink
Consumer
will
Start
Consuming
will
Stop
Consuming
will
Unmount
Properties
Optional
consume
consume
:
boolean
Readonly
downlink
downlink
:
null
|
EventDownlink
Readonly
downlink
Consumers
downlink
Consumers
:
readonly
unknown
[]
Readonly
downlink
Flags
downlink
Flags
:
number
Readonly
name
name
:
undefined
|
string
Readonly
own
Body
own
Body
:
null
|
Value
Readonly
own
Host
Uri
own
Host
Uri
:
null
|
Uri
Readonly
own
Lane
Uri
own
Lane
Uri
:
null
|
Uri
Readonly
own
Node
Uri
own
Node
Uri
:
null
|
Uri
Readonly
own
Prio
own
Prio
:
undefined
|
number
Readonly
own
Rate
own
Rate
:
undefined
|
number
Readonly
own
Warp
own
Warp
:
null
|
WarpRef
Readonly
owner
owner
:
M
Methods
add
Downlink
Consumer
add
Downlink
Consumer
(
downlinkConsumer
:
unknown
)
:
void
Parameters
downlinkConsumer:
unknown
Returns
void
bind
Downlink
bind
Downlink
(
downlink
:
EventDownlink
)
:
EventDownlink
Parameters
downlink:
EventDownlink
Returns
EventDownlink
body
body
(
)
:
null
|
Value
body
(
body
:
AnyValue
)
:
ModelEventDownlink
<
M
>
Returns
null
|
Value
Parameters
body:
AnyValue
Returns
ModelEventDownlink
<
M
>
create
Downlink
create
Downlink
(
warp
:
WarpRef
)
:
EventDownlink
Parameters
warp:
WarpRef
Returns
EventDownlink
did
Add
Downlink
Consumer
did
Add
Downlink
Consumer
(
downlinkConsumer
:
unknown
)
:
void
Parameters
downlinkConsumer:
unknown
Returns
void
did
Mount
did
Mount
(
)
:
void
Returns
void
did
Remove
Downlink
Consumer
did
Remove
Downlink
Consumer
(
downlinkConsumer
:
unknown
)
:
void
Parameters
downlinkConsumer:
unknown
Returns
void
did
Start
Consuming
did
Start
Consuming
(
)
:
void
Returns
void
did
Stop
Consuming
did
Stop
Consuming
(
)
:
void
Returns
void
did
Unmount
did
Unmount
(
)
:
void
Returns
void
host
Uri
host
Uri
(
)
:
null
|
Uri
host
Uri
(
hostUri
:
null
|
AnyUri
)
:
ModelEventDownlink
<
M
>
Returns
null
|
Uri
Parameters
hostUri:
null
|
AnyUri
Returns
ModelEventDownlink
<
M
>
Optional
init
Body
init
Body
(
)
:
AnyValue
Returns
AnyValue
Optional
init
Downlink
init
Downlink
(
downlink
:
EventDownlink
)
:
EventDownlink
Parameters
downlink:
EventDownlink
Returns
EventDownlink
Optional
init
Host
Uri
init
Host
Uri
(
)
:
null
|
AnyUri
Returns
null
|
AnyUri
Optional
init
Lane
Uri
init
Lane
Uri
(
)
:
null
|
AnyUri
Returns
null
|
AnyUri
Optional
init
Node
Uri
init
Node
Uri
(
)
:
null
|
AnyUri
Returns
null
|
AnyUri
Optional
init
Prio
init
Prio
(
)
:
undefined
|
number
Returns
undefined
|
number
Optional
init
Rate
init
Rate
(
)
:
undefined
|
number
Returns
undefined
|
number
is
Consuming
is
Consuming
(
)
:
boolean
Returns
boolean
is
Mounted
is
Mounted
(
)
:
boolean
Returns
boolean
lane
Uri
lane
Uri
(
)
:
null
|
Uri
lane
Uri
(
laneUri
:
null
|
AnyUri
)
:
ModelEventDownlink
<
M
>
Returns
null
|
Uri
Parameters
laneUri:
null
|
AnyUri
Returns
ModelEventDownlink
<
M
>
link
link
(
)
:
void
Returns
void
mount
mount
(
)
:
void
Returns
void
node
Uri
node
Uri
(
)
:
null
|
Uri
node
Uri
(
nodeUri
:
null
|
AnyUri
)
:
ModelEventDownlink
<
M
>
Returns
null
|
Uri
Parameters
nodeUri:
null
|
AnyUri
Returns
ModelEventDownlink
<
M
>
on
Add
Downlink
Consumer
on
Add
Downlink
Consumer
(
downlinkConsumer
:
unknown
)
:
void
Parameters
downlinkConsumer:
unknown
Returns
void
on
Mount
on
Mount
(
)
:
void
Returns
void
on
Remove
Downlink
Consumer
on
Remove
Downlink
Consumer
(
downlinkConsumer
:
unknown
)
:
void
Parameters
downlinkConsumer:
unknown
Returns
void
on
Start
Consuming
on
Start
Consuming
(
)
:
void
Returns
void
on
Stop
Consuming
on
Stop
Consuming
(
)
:
void
Returns
void
on
Unmount
on
Unmount
(
)
:
void
Returns
void
prio
prio
(
)
:
undefined
|
number
prio
(
prio
:
undefined
|
number
)
:
ModelEventDownlink
<
M
>
Returns
undefined
|
number
Parameters
prio:
undefined
|
number
Returns
ModelEventDownlink
<
M
>
rate
rate
(
)
:
undefined
|
number
rate
(
rate
:
undefined
|
number
)
:
ModelEventDownlink
<
M
>
Returns
undefined
|
number
Parameters
rate:
undefined
|
number
Returns
ModelEventDownlink
<
M
>
reconcile
reconcile
(
)
:
void
Returns
void
relink
relink
(
)
:
void
Returns
void
remove
Downlink
Consumer
remove
Downlink
Consumer
(
downlinkConsumer
:
unknown
)
:
void
Parameters
downlinkConsumer:
unknown
Returns
void
set
Downlink
Flags
set
Downlink
Flags
(
downlinkFlags
:
number
)
:
void
Parameters
downlinkFlags:
number
Returns
void
start
Consuming
start
Consuming
(
)
:
void
Returns
void
stop
Consuming
stop
Consuming
(
)
:
void
Returns
void
unlink
unlink
(
)
:
void
Returns
void
unmount
unmount
(
)
:
void
Returns
void
warp
warp
(
)
:
null
|
WarpRef
warp
(
warp
:
null
|
WarpRef
)
:
ModelEventDownlink
<
M
>
Returns
null
|
WarpRef
Parameters
warp:
null
|
WarpRef
Returns
ModelEventDownlink
<
M
>
will
Add
Downlink
Consumer
will
Add
Downlink
Consumer
(
downlinkConsumer
:
unknown
)
:
void
Parameters
downlinkConsumer:
unknown
Returns
void
will
Mount
will
Mount
(
)
:
void
Returns
void
will
Remove
Downlink
Consumer
will
Remove
Downlink
Consumer
(
downlinkConsumer
:
unknown
)
:
void
Parameters
downlinkConsumer:
unknown
Returns
void
will
Start
Consuming
will
Start
Consuming
(
)
:
void
Returns
void
will
Stop
Consuming
will
Stop
Consuming
(
)
:
void
Returns
void
will
Unmount
will
Unmount
(
)
:
void
Returns
void
Modules
@swim/system
@swim/toolkit
@swim/ui
@swim/model
@swim/style
@swim/theme
@swim/view
@swim/dom
@swim/graphics
@swim/component
@swim/ux
@swim/vis
@swim/maps
Model
Event
Downlink
consume
downlink
downlink
Consumers
downlink
Flags
name
own
Body
own
Host
Uri
own
Lane
Uri
own
Node
Uri
own
Prio
own
Rate
own
Warp
owner
add
Downlink
Consumer
bind
Downlink
body
create
Downlink
did
Add
Downlink
Consumer
did
Mount
did
Remove
Downlink
Consumer
did
Start
Consuming
did
Stop
Consuming
did
Unmount
host
Uri
init
Body
init
Downlink
init
Host
Uri
init
Lane
Uri
init
Node
Uri
init
Prio
init
Rate
is
Consuming
is
Mounted
lane
Uri
link
mount
node
Uri
on
Add
Downlink
Consumer
on
Mount
on
Remove
Downlink
Consumer
on
Start
Consuming
on
Stop
Consuming
on
Unmount
prio
rate
reconcile
relink
remove
Downlink
Consumer
set
Downlink
Flags
start
Consuming
stop
Consuming
unlink
unmount
warp
will
Add
Downlink
Consumer
will
Mount
will
Remove
Downlink
Consumer
will
Start
Consuming
will
Stop
Consuming
will
Unmount
Generated using
TypeDoc