matrix-js-sdk
Preparing search index...
matrix
<internal>
IIndexedDBBackend
Interface IIndexedDBBackend
interface
IIndexedDBBackend
{
clearDatabase
()
:
Promise
<
void
>
;
clearOutOfBandMembers
(
roomId
:
string
)
:
Promise
<
void
>
;
connect
(
onClose
?:
()
=>
void
)
:
Promise
<
void
>
;
destroy
()
:
Promise
<
void
>
;
getClientOptions
()
:
Promise
<
undefined
|
IStoredClientOpts
>
;
getNextBatchToken
()
:
Promise
<
string
>
;
getOldestToDeviceBatch
()
:
Promise
<
null
|
IndexedToDeviceBatch
>
;
getOutOfBandMembers
(
roomId
:
string
,
)
:
Promise
<
null
|
IStateEventWithRoomId
[]
>
;
getSavedSync
()
:
Promise
<
null
|
ISavedSync
>
;
getUserPresenceEvents
()
:
Promise
<
UserTuple
[]
>
;
isNewlyCreated
()
:
Promise
<
boolean
>
;
removeToDeviceBatch
(
id
:
number
)
:
Promise
<
void
>
;
saveToDeviceBatches
(
batches
:
ToDeviceBatchWithTxnId
[]
)
:
Promise
<
void
>
;
setOutOfBandMembers
(
roomId
:
string
,
membershipEvents
:
IStateEventWithRoomId
[]
,
)
:
Promise
<
void
>
;
setSyncData
(
syncData
:
ISyncResponse
)
:
Promise
<
void
>
;
storeClientOptions
(
options
:
IStoredClientOpts
)
:
Promise
<
void
>
;
syncToDatabase
(
userTuples
:
UserTuple
[]
)
:
Promise
<
void
>
;
}
Index
Methods
clear
Database
clear
Out
Of
Band
Members
connect
destroy
get
Client
Options
get
Next
Batch
Token
get
Oldest
To
Device
Batch
get
Out
Of
Band
Members
get
Saved
Sync
get
User
Presence
Events
is
Newly
Created
remove
To
Device
Batch
save
To
Device
Batches
set
Out
Of
Band
Members
set
Sync
Data
store
Client
Options
sync
To
Database
Methods
clear
Database
clearDatabase
()
:
Promise
<
void
>
Returns
Promise
<
void
>
clear
Out
Of
Band
Members
clearOutOfBandMembers
(
roomId
:
string
)
:
Promise
<
void
>
Parameters
roomId
:
string
Returns
Promise
<
void
>
connect
connect
(
onClose
?:
()
=>
void
)
:
Promise
<
void
>
Parameters
Optional
onClose
:
()
=>
void
Returns
Promise
<
void
>
destroy
destroy
()
:
Promise
<
void
>
Returns
Promise
<
void
>
get
Client
Options
getClientOptions
()
:
Promise
<
undefined
|
IStoredClientOpts
>
Returns
Promise
<
undefined
|
IStoredClientOpts
>
get
Next
Batch
Token
getNextBatchToken
()
:
Promise
<
string
>
Returns
Promise
<
string
>
get
Oldest
To
Device
Batch
getOldestToDeviceBatch
()
:
Promise
<
null
|
IndexedToDeviceBatch
>
Returns
Promise
<
null
|
IndexedToDeviceBatch
>
get
Out
Of
Band
Members
getOutOfBandMembers
(
roomId
:
string
)
:
Promise
<
null
|
IStateEventWithRoomId
[]
>
Parameters
roomId
:
string
Returns
Promise
<
null
|
IStateEventWithRoomId
[]
>
get
Saved
Sync
getSavedSync
()
:
Promise
<
null
|
ISavedSync
>
Returns
Promise
<
null
|
ISavedSync
>
get
User
Presence
Events
getUserPresenceEvents
()
:
Promise
<
UserTuple
[]
>
Returns
Promise
<
UserTuple
[]
>
is
Newly
Created
isNewlyCreated
()
:
Promise
<
boolean
>
Returns
Promise
<
boolean
>
remove
To
Device
Batch
removeToDeviceBatch
(
id
:
number
)
:
Promise
<
void
>
Parameters
id
:
number
Returns
Promise
<
void
>
save
To
Device
Batches
saveToDeviceBatches
(
batches
:
ToDeviceBatchWithTxnId
[]
)
:
Promise
<
void
>
Parameters
batches
:
ToDeviceBatchWithTxnId
[]
Returns
Promise
<
void
>
set
Out
Of
Band
Members
setOutOfBandMembers
(
roomId
:
string
,
membershipEvents
:
IStateEventWithRoomId
[]
,
)
:
Promise
<
void
>
Parameters
roomId
:
string
membershipEvents
:
IStateEventWithRoomId
[]
Returns
Promise
<
void
>
set
Sync
Data
setSyncData
(
syncData
:
ISyncResponse
)
:
Promise
<
void
>
Parameters
syncData
:
ISyncResponse
Returns
Promise
<
void
>
store
Client
Options
storeClientOptions
(
options
:
IStoredClientOpts
)
:
Promise
<
void
>
Parameters
options
:
IStoredClientOpts
Returns
Promise
<
void
>
sync
To
Database
syncToDatabase
(
userTuples
:
UserTuple
[]
)
:
Promise
<
void
>
Parameters
userTuples
:
UserTuple
[]
Returns
Promise
<
void
>
Settings
Member Visibility
Protected
Inherited
Theme
OS
Light
Dark
On This Page
Methods
clear
Database
clear
Out
Of
Band
Members
connect
destroy
get
Client
Options
get
Next
Batch
Token
get
Oldest
To
Device
Batch
get
Out
Of
Band
Members
get
Saved
Sync
get
User
Presence
Events
is
Newly
Created
remove
To
Device
Batch
save
To
Device
Batches
set
Out
Of
Band
Members
set
Sync
Data
store
Client
Options
sync
To
Database
matrix-js-sdk
Loading...