Interface ICryptoStore

Persistent storage of encryption state; pickles are encrypted, so the store itself need not be.

Namespace: Uniform.Matrix.Protocol.Crypto
Assembly: Uniform.Matrix.Protocol.Crypto.dll
Syntax
public interface ICryptoStore

Methods

| Edit this page View Source

DeleteOutboundGroupSessionAsync(string, CancellationToken)

Remove the outbound Megolm session of a room, forcing a new one.

Declaration
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, or null before the first run.

Declaration
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 stored device lists.

Declaration
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 Megolm session, or null.

Declaration
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 Olm sessions with the device of senderKey.

Declaration
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 the outbound Megolm session of a room, or null.

Declaration
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 up to limit inbound sessions not yet in the key backup.

Declaration
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 named value, or null; secrets in it are encrypted by the caller.

Declaration
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 every inbound session as not backed up, e.g. for a new backup version.

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

SaveAccountAsync(AccountRecord, CancellationToken)

Save the account.

Declaration
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)

Add or replace a user's device list.

Declaration
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)

Add or replace an inbound Megolm session.

Declaration
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)

Add or replace an Olm session.

Declaration
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)

Add or replace the outbound Megolm session of a room.

Declaration
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 a named value, or remove it when value is null.

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