LocalStorageCryptoStore

Defined in: src/crypto/store/localStorage-crypto-store.ts:67

Internal module. in-memory storage for e2e.

Extends

• MemoryCryptoStore

Implements

• CryptoStore

Constructors

Constructor

new LocalStorageCryptoStore(store): LocalStorageCryptoStore

Defined in: src/crypto/store/localStorage-crypto-store.ts:78

Parameters

store

Storage

Returns

LocalStorageCryptoStore

Overrides

MemoryCryptoStore.constructor

Methods

countEndToEndSessions()

countEndToEndSessions(txn, func): void

Defined in: src/crypto/store/localStorage-crypto-store.ts:117

Parameters

txn

unknown

func

(count) => void

Returns

void

Implementation of

CryptoStore.countEndToEndSessions

Overrides

MemoryCryptoStore.countEndToEndSessions

---

deleteAllData()

deleteAllData(): Promise<void>

Defined in: src/crypto/store/localStorage-crypto-store.ts:352

Delete all data from this store.

Returns

Promise<void>

Promise which resolves when the store has been cleared.

Implementation of

CryptoStore.deleteAllData

Overrides

MemoryCryptoStore.deleteAllData

---

doTxn()

doTxn<T>(mode, stores, func): Promise<T>

Defined in: src/crypto/store/localStorage-crypto-store.ts:390

Type Parameters

T

T

Parameters

mode

Mode

stores

Iterable<string>

func

(txn) => T

Returns

Promise<T>

Implementation of

CryptoStore.doTxn

Overrides

MemoryCryptoStore.doTxn

---

getAccount()

getAccount(txn, func): void

Defined in: src/crypto/store/localStorage-crypto-store.ts:359

Parameters

txn

unknown

func

(accountPickle) => void

Returns

void

Implementation of

CryptoStore.getAccount

Overrides

MemoryCryptoStore.getAccount

---

getCrossSigningKeys()

getCrossSigningKeys(txn, func): void

Defined in: src/crypto/store/localStorage-crypto-store.ts:368

Parameters

txn

unknown

func

(keys) => void

Returns

void

Implementation of

CryptoStore.getCrossSigningKeys

Overrides

MemoryCryptoStore.getCrossSigningKeys

---

getEndToEndInboundGroupSession()

getEndToEndInboundGroupSession(senderCurve25519Key, sessionId, txn, func): void

Defined in: src/crypto/store/localStorage-crypto-store.ts:224

Parameters

senderCurve25519Key

string

sessionId

string

txn

unknown

func

(groupSession, groupSessionWithheld) => void

Returns

void

Implementation of

CryptoStore.getEndToEndInboundGroupSession

Overrides

MemoryCryptoStore.getEndToEndInboundGroupSession

---

getEndToEndRooms()

getEndToEndRooms(txn, func): void

Defined in: src/crypto/store/localStorage-crypto-store.ts:321

Parameters

txn

unknown

func

(rooms) => void

Returns

void

Implementation of

CryptoStore.getEndToEndRooms

Overrides

MemoryCryptoStore.getEndToEndRooms

---

getEndToEndSession()

getEndToEndSession(deviceKey, sessionId, txn, func): void

Defined in: src/crypto/store/localStorage-crypto-store.ts:148

Parameters

deviceKey

string

sessionId

string

txn

unknown

func

(session) => void

Returns

void

Implementation of

CryptoStore.getEndToEndSession

Overrides

MemoryCryptoStore.getEndToEndSession

---

getEndToEndSessions()

getEndToEndSessions(deviceKey, txn, func): void

Defined in: src/crypto/store/localStorage-crypto-store.ts:158

Parameters

deviceKey

string

txn

unknown

func

(sessions) => void

Returns

void

Implementation of

CryptoStore.getEndToEndSessions

Overrides

MemoryCryptoStore.getEndToEndSessions

---

getSecretStorePrivateKey()

getSecretStorePrivateKey<K>(txn, func, type): void

Defined in: src/crypto/store/localStorage-crypto-store.ts:373

Type Parameters

K

K extends "m.megolm_backup.v1"

Parameters

txn

unknown

func

(key) => void

type

K

Returns

void

Implementation of

CryptoStore.getSecretStorePrivateKey

Overrides

MemoryCryptoStore.getSecretStorePrivateKey

---

markSessionsNeedingBackup()

markSessionsNeedingBackup(sessions): Promise<void>

Defined in: src/crypto/store/localStorage-crypto-store.ts:335

Parameters

sessions

ISession[]

Returns

Promise<void>

Implementation of

CryptoStore.markSessionsNeedingBackup

Overrides

MemoryCryptoStore.markSessionsNeedingBackup

---

startup()

startup(): Promise<CryptoStore>

Defined in: src/crypto/store/memory-crypto-store.ts:80

Ensure the database exists and is up-to-date.

This must be called before the store can be used.

Returns

Promise<CryptoStore>

resolves to the store.

Implementation of

CryptoStore.startup

Inherited from

MemoryCryptoStore.startup

---

storeAccount()

storeAccount(txn, accountPickle): void

Defined in: src/crypto/store/localStorage-crypto-store.ts:364

Parameters

txn

unknown

accountPickle

string

Returns

void

Implementation of

CryptoStore.storeAccount

Overrides

MemoryCryptoStore.storeAccount

---

storeEndToEndInboundGroupSession()

storeEndToEndInboundGroupSession(senderCurve25519Key, sessionId, sessionData, txn): void

Defined in: src/crypto/store/localStorage-crypto-store.ts:236

Parameters

senderCurve25519Key

string

sessionId

string

sessionData

InboundGroupSessionData

txn

unknown

Returns

void

Implementation of

CryptoStore.storeEndToEndInboundGroupSession

Overrides

MemoryCryptoStore.storeEndToEndInboundGroupSession

---

storeEndToEndSession()

storeEndToEndSession(deviceKey, sessionId, sessionInfo, txn): void

Defined in: src/crypto/store/localStorage-crypto-store.ts:166

Parameters

deviceKey

string

sessionId

string

sessionInfo

ISessionInfo

txn

unknown

Returns

void

Implementation of

CryptoStore.storeEndToEndSession

Overrides

MemoryCryptoStore.storeEndToEndSession

---

storeSecretStorePrivateKey()

storeSecretStorePrivateKey<K>(txn, type, key): void

Defined in: src/crypto/store/localStorage-crypto-store.ts:382

Type Parameters

K

K extends "m.megolm_backup.v1"

Parameters

txn

unknown

type

K

key

SecretStorePrivateKeys[K]

Returns

void

Implementation of

CryptoStore.storeSecretStorePrivateKey

Overrides

MemoryCryptoStore.storeSecretStorePrivateKey

---

exists()

static exists(store): boolean

Defined in: src/crypto/store/localStorage-crypto-store.ts:68

Parameters

store

Storage

Returns

boolean