Search
Preparing search index...
The search index is not available
swimOS
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
Globals
@swim/client
ListDownlink
Class ListDownlink<V, VU>
Type parameters
V
:
VU
VU
Hierarchy
Downlink
ListDownlink
Index
Accessors
length
Methods
body
clear
close
command
copy
did
Clear
did
Close
did
Connect
did
Disconnect
did
Drop
did
Fail
did
Link
did
Move
did
Remove
did
Sync
did
Take
did
Unlink
did
Update
entries
for
Each
get
get
Entry
host
Uri
initial
State
insert
is
Authenticated
is
Connected
is
Empty
is
Linked
is
Synced
keep
Linked
keep
Synced
keys
lane
Uri
move
node
Uri
observe
on
Command
on
Event
open
pop
prio
push
rate
remove
session
set
set
State
shift
snapshot
splice
type
unobserve
unshift
value
Form
values
will
Clear
will
Drop
will
Link
will
Move
will
Remove
will
Sync
will
Take
will
Unlink
will
Update
init
Form
Accessors
length
get
length
(
)
:
number
Returns
number
Methods
body
body
(
)
:
Value
body
(
body
:
AnyValue
)
:
this
Returns
Value
Parameters
body:
AnyValue
Returns
this
clear
clear
(
)
:
void
Returns
void
close
close
(
)
:
void
Returns
void
command
command
(
body
:
AnyValue
)
:
void
Parameters
body:
AnyValue
Returns
void
Protected
copy
copy
(
context
:
DownlinkContext
, owner
:
DownlinkOwner
|
undefined
, hostUri
:
Uri
, nodeUri
:
Uri
, laneUri
:
Uri
, prio
:
number
, rate
:
number
, body
:
Value
, flags
:
number
, observers
:
ReadonlyArray
<
ListDownlinkObserver
<
V
,
VU
>
>
|
null
, valueForm
?:
Form
<
V
,
VU
>
, state0
?:
STree
<
Value
,
Value
>
)
:
this
Parameters
context:
DownlinkContext
owner:
DownlinkOwner
|
undefined
hostUri:
Uri
nodeUri:
Uri
laneUri:
Uri
prio:
number
rate:
number
body:
Value
flags:
number
observers:
ReadonlyArray
<
ListDownlinkObserver
<
V
,
VU
>
>
|
null
Optional
valueForm:
Form
<
V
,
VU
>
Optional
state0:
STree
<
Value
,
Value
>
Returns
this
did
Clear
did
Clear
(
didClear
:
ListDownlinkDidClear
<
V
,
VU
>
)
:
this
Parameters
didClear:
ListDownlinkDidClear
<
V
,
VU
>
Returns
this
did
Close
did
Close
(
didClose
:
DownlinkDidClose
)
:
this
Parameters
didClose:
DownlinkDidClose
Returns
this
did
Connect
did
Connect
(
didConnect
:
DownlinkDidConnect
)
:
this
Parameters
didConnect:
DownlinkDidConnect
Returns
this
did
Disconnect
did
Disconnect
(
didDisconnect
:
DownlinkDidDisconnect
)
:
this
Parameters
didDisconnect:
DownlinkDidDisconnect
Returns
this
did
Drop
did
Drop
(
didDrop
:
ListDownlinkDidDrop
<
V
,
VU
>
)
:
this
Parameters
didDrop:
ListDownlinkDidDrop
<
V
,
VU
>
Returns
this
did
Fail
did
Fail
(
didFail
:
DownlinkDidFail
)
:
this
Parameters
didFail:
DownlinkDidFail
Returns
this
did
Link
did
Link
(
didLink
:
DownlinkDidLink
)
:
this
Parameters
didLink:
DownlinkDidLink
Returns
this
did
Move
did
Move
(
didMove
:
ListDownlinkDidMove
<
V
,
VU
>
)
:
this
Parameters
didMove:
ListDownlinkDidMove
<
V
,
VU
>
Returns
this
did
Remove
did
Remove
(
didRemove
:
ListDownlinkDidRemove
<
V
,
VU
>
)
:
this
Parameters
didRemove:
ListDownlinkDidRemove
<
V
,
VU
>
Returns
this
did
Sync
did
Sync
(
didSync
:
DownlinkDidSync
)
:
this
Parameters
didSync:
DownlinkDidSync
Returns
this
did
Take
did
Take
(
didTake
:
ListDownlinkDidTake
<
V
,
VU
>
)
:
this
Parameters
didTake:
ListDownlinkDidTake
<
V
,
VU
>
Returns
this
did
Unlink
did
Unlink
(
didUnlink
:
DownlinkDidUnlink
)
:
this
Parameters
didUnlink:
DownlinkDidUnlink
Returns
this
did
Update
did
Update
(
didUpdate
:
ListDownlinkDidUpdate
<
V
,
VU
>
)
:
this
Parameters
didUpdate:
ListDownlinkDidUpdate
<
V
,
VU
>
Returns
this
entries
entries
(
)
:
Cursor
<
[
Value
,
V
]
>
Returns
Cursor
<
[
Value
,
V
]
>
for
Each
for
Each<T, S>
(
callback
:
function
, thisArg
?:
S
)
:
T
|
undefined
Type parameters
T
S
Parameters
callback:
function
(
this
:
S
, value
:
V
, index
:
number
, downlink
:
ListDownlink
<
V
,
VU
>
, id
:
Value
)
:
T
|
void
Parameters
this:
S
value:
V
index:
number
downlink:
ListDownlink
<
V
,
VU
>
id:
Value
Returns
T
|
void
Optional
thisArg:
S
Returns
T
|
undefined
get
get
(
index
:
number
, id
?:
Value
)
:
V
Parameters
index:
number
Optional
id:
Value
Returns
V
get
Entry
get
Entry
(
index
:
number
, id
?:
Value
)
:
[
V
,
Value
]
|
undefined
Parameters
index:
number
Optional
id:
Value
Returns
[
V
,
Value
]
|
undefined
host
Uri
host
Uri
(
)
:
Uri
host
Uri
(
hostUri
:
AnyUri
)
:
this
Returns
Uri
Parameters
hostUri:
AnyUri
Returns
this
initial
State
initial
State
(
)
:
STree
<
Value
,
Value
>
|
null
initial
State
(
state0
:
STree
<
Value
,
Value
>
|
null
)
:
this
Returns
STree
<
Value
,
Value
>
|
null
Parameters
state0:
STree
<
Value
,
Value
>
|
null
Returns
this
insert
insert
(
index
:
number
, newObject
:
VU
, id
?:
Value
)
:
this
Parameters
index:
number
newObject:
VU
Optional
id:
Value
Returns
this
is
Authenticated
is
Authenticated
(
)
:
boolean
Returns
boolean
is
Connected
is
Connected
(
)
:
boolean
Returns
boolean
is
Empty
is
Empty
(
)
:
boolean
Returns
boolean
is
Linked
is
Linked
(
)
:
boolean
Returns
boolean
is
Synced
is
Synced
(
)
:
boolean
Returns
boolean
keep
Linked
keep
Linked
(
)
:
boolean
keep
Linked
(
keepLinked
:
boolean
)
:
this
Returns
boolean
Parameters
keepLinked:
boolean
Returns
this
keep
Synced
keep
Synced
(
)
:
boolean
keep
Synced
(
keepSynced
:
boolean
)
:
this
Returns
boolean
Parameters
keepSynced:
boolean
Returns
this
keys
keys
(
)
:
Cursor
<
Value
>
Returns
Cursor
<
Value
>
lane
Uri
lane
Uri
(
)
:
Uri
lane
Uri
(
laneUri
:
AnyUri
)
:
this
Returns
Uri
Parameters
laneUri:
AnyUri
Returns
this
move
move
(
fromIndex
:
number
, toIndex
:
number
, id
?:
Value
)
:
this
Parameters
fromIndex:
number
toIndex:
number
Optional
id:
Value
Returns
this
node
Uri
node
Uri
(
)
:
Uri
node
Uri
(
nodeUri
:
AnyUri
)
:
this
Returns
Uri
Parameters
nodeUri:
AnyUri
Returns
this
observe
observe
(
observer
:
ListDownlinkObserver
<
V
,
VU
>
)
:
this
Parameters
observer:
ListDownlinkObserver
<
V
,
VU
>
Returns
this
on
Command
on
Command
(
onCommand
:
DownlinkOnCommand
)
:
this
Parameters
onCommand:
DownlinkOnCommand
Returns
this
on
Event
on
Event
(
onEvent
:
DownlinkOnEvent
)
:
this
Parameters
onEvent:
DownlinkOnEvent
Returns
this
open
open
(
)
:
this
Returns
this
pop
pop
(
)
:
V
Returns
V
prio
prio
(
)
:
number
prio
(
prio
:
number
)
:
this
Returns
number
Parameters
prio:
number
Returns
this
push
push
(
...
newObjects
:
VU
[]
)
:
number
Parameters
Rest
...
newObjects:
VU
[]
Returns
number
rate
rate
(
)
:
number
rate
(
rate
:
number
)
:
this
Returns
number
Parameters
rate:
number
Returns
this
remove
remove
(
index
:
number
, id
?:
Value
)
:
this
Parameters
index:
number
Optional
id:
Value
Returns
this
session
session
(
)
:
Value
Returns
Value
set
set
(
index
:
number
, newObject
:
VU
, id
?:
Value
)
:
this
Parameters
index:
number
newObject:
VU
Optional
id:
Value
Returns
this
set
State
set
State
(
state
:
STree
<
Value
,
Value
>
)
:
void
Parameters
state:
STree
<
Value
,
Value
>
Returns
void
shift
shift
(
)
:
V
Returns
V
snapshot
snapshot
(
)
:
STree
<
Value
,
Value
>
Returns
STree
<
Value
,
Value
>
splice
splice
(
start
:
number
, deleteCount
?:
undefined
|
number
,
...
newObjects
:
VU
[]
)
:
V
[]
Parameters
start:
number
Optional
deleteCount:
undefined
|
number
Rest
...
newObjects:
VU
[]
Returns
V
[]
type
type
(
)
:
DownlinkType
Returns
DownlinkType
unobserve
unobserve
(
observer
:
unknown
)
:
this
Parameters
observer:
unknown
Returns
this
unshift
unshift
(
...
newObjects
:
VU
[]
)
:
number
Parameters
Rest
...
newObjects:
VU
[]
Returns
number
value
Form
value
Form
(
)
:
Form
<
V
,
VU
>
value
Form<V2, V2U>
(
valueForm
:
Form
<
V2
,
V2U
>
)
:
ListDownlink
<
V2
,
V2U
>
Returns
Form
<
V
,
VU
>
Type parameters
V2
:
V2U
V2U
Parameters
valueForm:
Form
<
V2
,
V2U
>
Returns
ListDownlink
<
V2
,
V2U
>
values
values
(
)
:
Cursor
<
V
>
Returns
Cursor
<
V
>
will
Clear
will
Clear
(
willClear
:
ListDownlinkWillClear
<
V
,
VU
>
)
:
this
Parameters
willClear:
ListDownlinkWillClear
<
V
,
VU
>
Returns
this
will
Drop
will
Drop
(
willDrop
:
ListDownlinkWillDrop
<
V
,
VU
>
)
:
this
Parameters
willDrop:
ListDownlinkWillDrop
<
V
,
VU
>
Returns
this
will
Link
will
Link
(
willLink
:
DownlinkWillLink
)
:
this
Parameters
willLink:
DownlinkWillLink
Returns
this
will
Move
will
Move
(
willMove
:
ListDownlinkWillMove
<
V
,
VU
>
)
:
this
Parameters
willMove:
ListDownlinkWillMove
<
V
,
VU
>
Returns
this
will
Remove
will
Remove
(
willRemove
:
ListDownlinkWillRemove
<
V
,
VU
>
)
:
this
Parameters
willRemove:
ListDownlinkWillRemove
<
V
,
VU
>
Returns
this
will
Sync
will
Sync
(
willSync
:
DownlinkWillSync
)
:
this
Parameters
willSync:
DownlinkWillSync
Returns
this
will
Take
will
Take
(
willTake
:
ListDownlinkWillTake
<
V
,
VU
>
)
:
this
Parameters
willTake:
ListDownlinkWillTake
<
V
,
VU
>
Returns
this
will
Unlink
will
Unlink
(
willUnlink
:
DownlinkWillUnlink
)
:
this
Parameters
willUnlink:
DownlinkWillUnlink
Returns
this
will
Update
will
Update
(
willUpdate
:
ListDownlinkWillUpdate
<
V
,
VU
>
)
:
this
Parameters
willUpdate:
ListDownlinkWillUpdate
<
V
,
VU
>
Returns
this
Static
init
Form
init
Form
(
)
:
Form
<
DownlinkInit
|
undefined
>
Returns
Form
<
DownlinkInit
|
undefined
>
Globals
@swim/core
@swim/mesh
@swim/client
@swim/warp
@swim/ui
@swim/ux
@swim/web
List
Downlink
length
body
clear
close
command
copy
did
Clear
did
Close
did
Connect
did
Disconnect
did
Drop
did
Fail
did
Link
did
Move
did
Remove
did
Sync
did
Take
did
Unlink
did
Update
entries
for
Each
get
get
Entry
host
Uri
initial
State
insert
is
Authenticated
is
Connected
is
Empty
is
Linked
is
Synced
keep
Linked
keep
Synced
keys
lane
Uri
move
node
Uri
observe
on
Command
on
Event
open
pop
prio
push
rate
remove
session
set
set
State
shift
snapshot
splice
type
unobserve
unshift
value
Form
values
will
Clear
will
Drop
will
Link
will
Move
will
Remove
will
Sync
will
Take
will
Unlink
will
Update
init
Form