Class EfCryptoStore

ICryptoStore in the client's SQLite database; pickles are encrypted with the key in crypto.key.

Inheritance
object
EfCryptoStore
Implements
Inherited Members
Namespace: Uniform.Matrix.Client.Storage
Assembly: Uniform.Matrix.Client.dll
Syntax
public sealed class EfCryptoStore : ICryptoStore

Constructors

| Edit this page View Source

EfCryptoStore(IDbContextFactory<ClientDbContext>)

Create a store over contexts.

Declaration
public EfCryptoStore(IDbContextFactory<ClientDbContext> contexts)
Parameters
Type Name Description
IDbContextFactory<ClientDbContext> contexts

Properties

| Edit this page View Source

DeviceId

Device the stored account belongs to; sets by ResetForDeviceAsync(string, CancellationToken).

Declaration
public string? DeviceId { get; }
Property Value
Type Description
string

Methods

| Edit this page View Source

DeleteOutboundGroupSessionAsync(string, CancellationToken)

Remove a room's outbound session.

Declaration
public Task DeleteOutboundGroupSessionAsync(string roomId, CancellationToken cancellationToken)
Parameters
Type Name Description
string roomId
CancellationToken cancellationToken
Returns
Type Description
Task
| Edit this page View Source

LoadAccountAsync(CancellationToken)

Return the account.

Declaration
public Task<AccountRecord?> LoadAccountAsync(CancellationToken cancellationToken)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<AccountRecord>
| Edit this page View Source

LoadDeviceListsAsync(CancellationToken)

Return all device lists.

Declaration
public Task<IReadOnlyList<DeviceListRecord>> LoadDeviceListsAsync(CancellationToken cancellationToken)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<IReadOnlyList<DeviceListRecord>>
| Edit this page View Source

LoadInboundGroupSessionAsync(string, string, CancellationToken)

Return an inbound session.

Declaration
public Task<InboundGroupSessionRecord?> LoadInboundGroupSessionAsync(string roomId, string sessionId, CancellationToken cancellationToken)
Parameters
Type Name Description
string roomId
string sessionId
CancellationToken cancellationToken
Returns
Type Description
Task<InboundGroupSessionRecord>
| Edit this page View Source

LoadOlmSessionsAsync(string, CancellationToken)

Return sessions with a device.

Declaration
public Task<IReadOnlyList<OlmSessionRecord>> LoadOlmSessionsAsync(string senderKey, CancellationToken cancellationToken)
Parameters
Type Name Description
string senderKey
CancellationToken cancellationToken
Returns
Type Description
Task<IReadOnlyList<OlmSessionRecord>>
| Edit this page View Source

LoadOutboundGroupSessionAsync(string, CancellationToken)

Return a room's outbound session.

Declaration
public Task<OutboundGroupSessionRecord?> LoadOutboundGroupSessionAsync(string roomId, CancellationToken cancellationToken)
Parameters
Type Name Description
string roomId
CancellationToken cancellationToken
Returns
Type Description
Task<OutboundGroupSessionRecord>
| Edit this page View Source

LoadSessionsToBackUpAsync(int, CancellationToken)

Return sessions not backed up.

Declaration
public Task<IReadOnlyList<InboundGroupSessionRecord>> LoadSessionsToBackUpAsync(int limit, CancellationToken cancellationToken)
Parameters
Type Name Description
int limit
CancellationToken cancellationToken
Returns
Type Description
Task<IReadOnlyList<InboundGroupSessionRecord>>
| Edit this page View Source

LoadValueAsync(string, CancellationToken)

Return a value.

Declaration
public Task<string?> LoadValueAsync(string name, CancellationToken cancellationToken)
Parameters
Type Name Description
string name
CancellationToken cancellationToken
Returns
Type Description
Task<string>
| Edit this page View Source

ResetBackedUpAsync(CancellationToken)

Mark all sessions not backed up.

Declaration
public Task ResetBackedUpAsync(CancellationToken cancellationToken)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task
| Edit this page View Source

ResetForDeviceAsync(string, CancellationToken)

Clear all encryption state when it belongs to another device than deviceId, e.g. after a new login.

Declaration
public Task<bool> ResetForDeviceAsync(string deviceId, CancellationToken cancellationToken = default)
Parameters
Type Name Description
string deviceId
CancellationToken cancellationToken
Returns
Type Description
Task<bool>

Whether state was cleared.
| Edit this page View Source

SaveAccountAsync(AccountRecord, CancellationToken)

Save the account.

Declaration
public Task SaveAccountAsync(AccountRecord account, CancellationToken cancellationToken)
Parameters
Type Name Description
AccountRecord account
CancellationToken cancellationToken
Returns
Type Description
Task
| Edit this page View Source

SaveDeviceListAsync(DeviceListRecord, CancellationToken)

Save a device list.

Declaration
public Task SaveDeviceListAsync(DeviceListRecord deviceList, CancellationToken cancellationToken)
Parameters
Type Name Description
DeviceListRecord deviceList
CancellationToken cancellationToken
Returns
Type Description
Task
| Edit this page View Source

SaveInboundGroupSessionAsync(InboundGroupSessionRecord, CancellationToken)

Save an inbound session.

Declaration
public Task SaveInboundGroupSessionAsync(InboundGroupSessionRecord session, CancellationToken cancellationToken)
Parameters
Type Name Description
InboundGroupSessionRecord session
CancellationToken cancellationToken
Returns
Type Description
Task
| Edit this page View Source

SaveOlmSessionAsync(OlmSessionRecord, CancellationToken)

Save a session.

Declaration
public Task SaveOlmSessionAsync(OlmSessionRecord session, CancellationToken cancellationToken)
Parameters
Type Name Description
OlmSessionRecord session
CancellationToken cancellationToken
Returns
Type Description
Task
| Edit this page View Source

SaveOutboundGroupSessionAsync(OutboundGroupSessionRecord, CancellationToken)

Save a room's outbound session.

Declaration
public Task SaveOutboundGroupSessionAsync(OutboundGroupSessionRecord session, CancellationToken cancellationToken)
Parameters
Type Name Description
OutboundGroupSessionRecord session
CancellationToken cancellationToken
Returns
Type Description
Task
| Edit this page View Source

SaveValueAsync(string, string?, CancellationToken)

Set or remove a value.

Declaration
public Task SaveValueAsync(string name, string? value, CancellationToken cancellationToken)
Parameters
Type Name Description
string name
string value
CancellationToken cancellationToken
Returns
Type Description
Task

Implements