Class ClientConnection

The client engine of one signed-in account, running in its own .NET host until disposed.

Inheritance
object
ClientConnection
Implements
Inherited Members
Namespace: Uniform.Chat.Avalonia.Services
Assembly: Uniform.Chat.Avalonia.dll
Syntax
public sealed class ClientConnection : IAsyncDisposable
Remarks

The engine needs the user ID when it starts, so the app starts one connection per sign-in instead of one host for its whole life.

Properties

| Edit this page View Source

Calls

Voice calls.

Declaration
public CallService Calls { get; }
Property Value
Type Description
CallService
| Edit this page View Source

Crypto

End-to-end encryption.

Declaration
public CryptoService Crypto { get; }
Property Value
Type Description
CryptoService
| Edit this page View Source

LogPath

This session's log file, in the folder of the earlier sessions' logs; null when there is none.

Declaration
public string? LogPath { get; }
Property Value
Type Description
string
| Edit this page View Source

Logger

Log of the user interface, written to the session log.

Declaration
public ILogger Logger { get; }
Property Value
Type Description
ILogger
| Edit this page View Source

Media

Downloaded media and thumbnails.

Declaration
public MediaCache Media { get; }
Property Value
Type Description
MediaCache
| Edit this page View Source

Outbox

Messages waiting to be sent.

Declaration
public OutboxSender Outbox { get; }
Property Value
Type Description
OutboxSender
| Edit this page View Source

Processor

Room state and the stream of sync changes.

Declaration
public SyncProcessor Processor { get; }
Property Value
Type Description
SyncProcessor
| Edit this page View Source

Session

Login and the logged-in client.

Declaration
public ClientSession Session { get; }
Property Value
Type Description
ClientSession
| Edit this page View Source

Status

Connection state for the status line.

Declaration
public ConnectionStatus Status { get; }
Property Value
Type Description
ConnectionStatus
| Edit this page View Source

Store

Local database.

Declaration
public ClientStore Store { get; }
Property Value
Type Description
ClientStore
| Edit this page View Source

UserId

Signed-in user.

Declaration
public string UserId { get; }
Property Value
Type Description
string

Methods

| Edit this page View Source

DisplayNameOf(string)

Return a user's display name from the rooms shared with them, or the user ID when none is known.

Declaration
public string DisplayNameOf(string userId)
Parameters
Type Name Description
string userId
Returns
Type Description
string
| Edit this page View Source

DisposeAsync()

Stop the engine.

Declaration
public ValueTask DisposeAsync()
Returns
Type Description
ValueTask
| Edit this page View Source

LogOutAsync()

Log out on the server, which deletes this device, then stop the engine.

Declaration
public Task LogOutAsync()
Returns
Type Description
Task
| Edit this page View Source

StartAsync(GuiPlatform, SignIn, CancellationToken)

Start the engine for signIn; the login itself runs in the background, see WaitForLoginAsync(CancellationToken).

Declaration
public static Task<ClientConnection> StartAsync(GuiPlatform platform, SignIn signIn, CancellationToken cancellationToken = default)
Parameters
Type Name Description
GuiPlatform platform
SignIn signIn
CancellationToken cancellationToken
Returns
Type Description
Task<ClientConnection>
| Edit this page View Source

WaitForLoginAsync(CancellationToken)

Wait until the engine has logged in; throw with the engine's reason when it fails, e.g. a wrong password.

Declaration
public Task<MatrixClient> WaitForLoginAsync(CancellationToken cancellationToken = default)
Parameters
Type Name Description
CancellationToken cancellationToken
Returns
Type Description
Task<MatrixClient>

Implements