SignalCD Modern PoC API
Preparing search index...
storage/src
DurableCollaborativeStorage
Interface DurableCollaborativeStorage
interface
DurableCollaborativeStorage
{
acknowledgeOutbound
(
id
:
string
)
:
Promise
<
void
>
;
close
()
:
Promise
<
void
>
;
commitAccessChange
(
input
:
{
access
:
DocumentAccessState
;
authorization
?:
StoredAuthorizationState
;
documentId
:
string
;
outbound
:
readonly
OutboundRecord
[]
;
seen
?:
readonly
SeenMessage
[]
;
}
,
)
:
Promise
<
void
>
;
commitLocalChange
(
input
:
{
document
:
StoredDocument
;
outbound
:
readonly
OutboundRecord
[]
;
}
,
)
:
Promise
<
void
>
;
compactOutbound
(
documentId
:
string
,
policy
:
CheckpointPolicy
,
)
:
Promise
<
void
>
;
deleteDocument
(
documentId
:
string
)
:
Promise
<
void
>
;
enqueue
(
record
:
OutboundRecord
)
:
Promise
<
void
>
;
hasSeen
(
documentId
:
string
,
messageId
:
string
,
now
?:
number
,
)
:
Promise
<
boolean
>
;
listDocuments
()
:
Promise
<
readonly
StoredDocument
[]
>
;
listOutbound
(
documentId
?:
string
)
:
Promise
<
readonly
OutboundRecord
[]
>
;
loadAccessControl
(
documentId
:
string
,
)
:
Promise
<
DocumentAccessState
|
undefined
>
;
loadAuthorizationState
(
documentId
:
string
,
)
:
Promise
<
StoredAuthorizationState
|
undefined
>
;
loadDocument
(
documentId
:
string
)
:
Promise
<
StoredDocument
|
undefined
>
;
markOutboundAttempt
(
recordIds
:
readonly
string
[]
,
attemptedAt
:
number
,
)
:
Promise
<
void
>
;
persistRemoteState
(
input
:
{
document
:
StoredDocument
;
seen
:
readonly
SeenMessage
[]
}
,
)
:
Promise
<
void
>
;
pruneSeenMessages
(
now
?:
number
)
:
Promise
<
number
>
;
saveAccessControl
(
documentId
:
string
,
state
:
DocumentAccessState
,
)
:
Promise
<
void
>
;
saveDocument
(
document
:
StoredDocument
)
:
Promise
<
void
>
;
updateDocumentMetadata
(
documentId
:
string
,
update
:
DocumentMetadataUpdate
,
updatedAt
:
number
,
)
:
Promise
<
StoredDocument
>
;
}
Hierarchy (
View Summary
)
CollaborativeStorage
AccessControlStorage
DurableCollaborativeStorage
Implemented by
IndexedDbCollaborativeStorage
MemoryCollaborativeStorage
Index
Methods
acknowledge
Outbound
close
commit
Access
Change
commit
Local
Change
compact
Outbound
delete
Document
enqueue
has
Seen
list
Documents
list
Outbound
load
Access
Control
load
Authorization
State
load
Document
mark
Outbound
Attempt
persist
Remote
State
prune
Seen
Messages
save
Access
Control
save
Document
update
Document
Metadata
Methods
acknowledge
Outbound
acknowledgeOutbound
(
id
:
string
)
:
Promise
<
void
>
Parameters
id
:
string
Returns
Promise
<
void
>
close
close
()
:
Promise
<
void
>
Returns
Promise
<
void
>
commit
Access
Change
commitAccessChange
(
input
:
{
access
:
DocumentAccessState
;
authorization
?:
StoredAuthorizationState
;
documentId
:
string
;
outbound
:
readonly
OutboundRecord
[]
;
seen
?:
readonly
SeenMessage
[]
;
}
,
)
:
Promise
<
void
>
Parameters
input
:
{
access
:
DocumentAccessState
;
authorization
?:
StoredAuthorizationState
;
documentId
:
string
;
outbound
:
readonly
OutboundRecord
[]
;
seen
?:
readonly
SeenMessage
[]
;
}
Returns
Promise
<
void
>
commit
Local
Change
commitLocalChange
(
input
:
{
document
:
StoredDocument
;
outbound
:
readonly
OutboundRecord
[]
}
,
)
:
Promise
<
void
>
Parameters
input
:
{
document
:
StoredDocument
;
outbound
:
readonly
OutboundRecord
[]
}
Returns
Promise
<
void
>
compact
Outbound
compactOutbound
(
documentId
:
string
,
policy
:
CheckpointPolicy
)
:
Promise
<
void
>
Parameters
documentId
:
string
policy
:
CheckpointPolicy
Returns
Promise
<
void
>
delete
Document
deleteDocument
(
documentId
:
string
)
:
Promise
<
void
>
Parameters
documentId
:
string
Returns
Promise
<
void
>
enqueue
enqueue
(
record
:
OutboundRecord
)
:
Promise
<
void
>
Parameters
record
:
OutboundRecord
Returns
Promise
<
void
>
has
Seen
hasSeen
(
documentId
:
string
,
messageId
:
string
,
now
?:
number
)
:
Promise
<
boolean
>
Parameters
documentId
:
string
messageId
:
string
Optional
now
:
number
Returns
Promise
<
boolean
>
list
Documents
listDocuments
()
:
Promise
<
readonly
StoredDocument
[]
>
Returns
Promise
<
readonly
StoredDocument
[]
>
list
Outbound
listOutbound
(
documentId
?:
string
)
:
Promise
<
readonly
OutboundRecord
[]
>
Parameters
Optional
documentId
:
string
Returns
Promise
<
readonly
OutboundRecord
[]
>
load
Access
Control
loadAccessControl
(
documentId
:
string
)
:
Promise
<
DocumentAccessState
|
undefined
>
Parameters
documentId
:
string
Returns
Promise
<
DocumentAccessState
|
undefined
>
load
Authorization
State
loadAuthorizationState
(
documentId
:
string
,
)
:
Promise
<
StoredAuthorizationState
|
undefined
>
Parameters
documentId
:
string
Returns
Promise
<
StoredAuthorizationState
|
undefined
>
load
Document
loadDocument
(
documentId
:
string
)
:
Promise
<
StoredDocument
|
undefined
>
Parameters
documentId
:
string
Returns
Promise
<
StoredDocument
|
undefined
>
mark
Outbound
Attempt
markOutboundAttempt
(
recordIds
:
readonly
string
[]
,
attemptedAt
:
number
,
)
:
Promise
<
void
>
Parameters
recordIds
:
readonly
string
[]
attemptedAt
:
number
Returns
Promise
<
void
>
persist
Remote
State
persistRemoteState
(
input
:
{
document
:
StoredDocument
;
seen
:
readonly
SeenMessage
[]
}
,
)
:
Promise
<
void
>
Parameters
input
:
{
document
:
StoredDocument
;
seen
:
readonly
SeenMessage
[]
}
Returns
Promise
<
void
>
prune
Seen
Messages
pruneSeenMessages
(
now
?:
number
)
:
Promise
<
number
>
Parameters
Optional
now
:
number
Returns
Promise
<
number
>
save
Access
Control
saveAccessControl
(
documentId
:
string
,
state
:
DocumentAccessState
)
:
Promise
<
void
>
Parameters
documentId
:
string
state
:
DocumentAccessState
Returns
Promise
<
void
>
save
Document
saveDocument
(
document
:
StoredDocument
)
:
Promise
<
void
>
Parameters
document
:
StoredDocument
Returns
Promise
<
void
>
update
Document
Metadata
updateDocumentMetadata
(
documentId
:
string
,
update
:
DocumentMetadataUpdate
,
updatedAt
:
number
,
)
:
Promise
<
StoredDocument
>
Parameters
documentId
:
string
update
:
DocumentMetadataUpdate
updatedAt
:
number
Returns
Promise
<
StoredDocument
>
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
On This Page
Methods
acknowledge
Outbound
close
commit
Access
Change
commit
Local
Change
compact
Outbound
delete
Document
enqueue
has
Seen
list
Documents
list
Outbound
load
Access
Control
load
Authorization
State
load
Document
mark
Outbound
Attempt
persist
Remote
State
prune
Seen
Messages
save
Access
Control
save
Document
update
Document
Metadata
SignalCD Modern PoC API
Loading...