Class MatrixKeyTransport

IKeyTransport over a logged-in MatrixClient.

Inheritance
object
MatrixKeyTransport
Implements
Inherited Members
Namespace: Uniform.Matrix.Client
Assembly: Uniform.Matrix.Client.dll
Syntax
public sealed class MatrixKeyTransport : IKeyTransport

Constructors

| Edit this page View Source

MatrixKeyTransport(MatrixClient)

IKeyTransport over a logged-in MatrixClient.

Declaration
public MatrixKeyTransport(MatrixClient client)
Parameters
Type Name Description
MatrixClient client

Methods

| Edit this page View Source

ClaimKeysAsync(IReadOnlyDictionary<string, IReadOnlyList<string>>, CancellationToken)

Claim one-time keys.

Declaration
public Task<KeysClaimResponse> ClaimKeysAsync(IReadOnlyDictionary<string, IReadOnlyList<string>> devices, CancellationToken cancellationToken)
Parameters
Type Name Description
IReadOnlyDictionary<string, IReadOnlyList<string>> devices
CancellationToken cancellationToken
Returns
Type Description
Task<KeysClaimResponse>
| Edit this page View Source

CreateKeyBackupVersionAsync(string, JsonObject, CancellationToken)

Create a key backup version.

Declaration
public Task<string> CreateKeyBackupVersionAsync(string algorithm, JsonObject authData, CancellationToken cancellationToken)
Parameters
Type Name Description
string algorithm
JsonObject authData
CancellationToken cancellationToken
Returns
Type Description
Task<string>
| Edit this page View Source

GetAccountDataAsync(string, CancellationToken)

Return account data.

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

GetKeyBackupVersionAsync(CancellationToken)

Return the current key backup.

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

GetRoomKeysAsync(string, CancellationToken)

Download backed-up keys.

Declaration
public Task<KeysBackup> GetRoomKeysAsync(string version, CancellationToken cancellationToken)
Parameters
Type Name Description
string version
CancellationToken cancellationToken
Returns
Type Description
Task<KeysBackup>
| Edit this page View Source

QueryKeysAsync(IReadOnlyCollection<string>, CancellationToken)

Query device keys.

Declaration
public Task<KeysQueryResponse> QueryKeysAsync(IReadOnlyCollection<string> userIds, CancellationToken cancellationToken)
Parameters
Type Name Description
IReadOnlyCollection<string> userIds
CancellationToken cancellationToken
Returns
Type Description
Task<KeysQueryResponse>
| Edit this page View Source

SendToDeviceAsync(string, IReadOnlyDictionary<string, Dictionary<string, object>>, CancellationToken)

Send to-device messages.

Declaration
public Task SendToDeviceAsync(string eventType, IReadOnlyDictionary<string, Dictionary<string, object>> messages, CancellationToken cancellationToken)
Parameters
Type Name Description
string eventType
IReadOnlyDictionary<string, Dictionary<string, object>> messages
CancellationToken cancellationToken
Returns
Type Description
Task
| Edit this page View Source

SetAccountDataAsync(string, JsonObject, CancellationToken)

Set account data.

Declaration
public Task SetAccountDataAsync(string type, JsonObject content, CancellationToken cancellationToken)
Parameters
Type Name Description
string type
JsonObject content
CancellationToken cancellationToken
Returns
Type Description
Task
| Edit this page View Source

UploadCrossSigningKeysAsync(JsonObject, JsonObject, JsonObject, string?, CancellationToken)

Upload cross-signing keys.

Declaration
public Task UploadCrossSigningKeysAsync(JsonObject masterKey, JsonObject selfSigningKey, JsonObject userSigningKey, string? password, CancellationToken cancellationToken)
Parameters
Type Name Description
JsonObject masterKey
JsonObject selfSigningKey
JsonObject userSigningKey
string password
CancellationToken cancellationToken
Returns
Type Description
Task
| Edit this page View Source

UploadKeysAsync(JsonObject?, JsonObject?, JsonObject?, CancellationToken)

Upload keys.

Declaration
public Task<KeysUploadResponse> UploadKeysAsync(JsonObject? deviceKeys, JsonObject? oneTimeKeys, JsonObject? fallbackKeys, CancellationToken cancellationToken)
Parameters
Type Name Description
JsonObject deviceKeys
JsonObject oneTimeKeys
JsonObject fallbackKeys
CancellationToken cancellationToken
Returns
Type Description
Task<KeysUploadResponse>
| Edit this page View Source

UploadRoomKeysAsync(string, KeysBackup, CancellationToken)

Upload backed-up keys.

Declaration
public Task UploadRoomKeysAsync(string version, KeysBackup keys, CancellationToken cancellationToken)
Parameters
Type Name Description
string version
KeysBackup keys
CancellationToken cancellationToken
Returns
Type Description
Task
| Edit this page View Source

UploadSignaturesAsync(IReadOnlyDictionary<string, Dictionary<string, JsonObject>>, CancellationToken)

Upload signatures.

Declaration
public Task UploadSignaturesAsync(IReadOnlyDictionary<string, Dictionary<string, JsonObject>> signatures, CancellationToken cancellationToken)
Parameters
Type Name Description
IReadOnlyDictionary<string, Dictionary<string, JsonObject>> signatures
CancellationToken cancellationToken
Returns
Type Description
Task

Implements