Class MatrixOptions

Account and sync settings, configuration section Section.

Inheritance
object
MatrixOptions
Implements
Inherited Members
Namespace: Uniform.Matrix.Client.Configuration
Assembly: Uniform.Matrix.Client.dll
Syntax
public sealed record MatrixOptions : IEquatable<MatrixOptions>
Examples
dotnet run --project src/Uniform.Chat.Terminal -- --Matrix:UserId=@alice:matrix.org

Fields

| Edit this page View Source

Section

Configuration section name.

Declaration
public const string Section = "Matrix"
Field Value
Type Description
string

Properties

| Edit this page View Source

DeviceName

Display name of the device created at login.

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

Homeserver

Homeserver address, e.g. http://localhost:8008, for servers without .well-known discovery; when unset, found from the server name of UserId. Used at the first login.

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

OutboxRetryInterval

Wait before retrying unsent messages after a transient failure.

Declaration
public TimeSpan OutboxRetryInterval { get; set; }
Property Value
Type Description
TimeSpan
| Edit this page View Source

Password

Password for the first login; prompted when null. Not needed once a session is stored.

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

RequestTimeout

How long to wait for the server to answer a request, at least SyncTimeout and 30 seconds; joining a large room on another server can take minutes.

Declaration
public TimeSpan RequestTimeout { get; set; }
Property Value
Type Description
TimeSpan
| Edit this page View Source

SyncTimeout

Long-poll time of each sync request.

Declaration
public TimeSpan SyncTimeout { get; set; }
Property Value
Type Description
TimeSpan
| Edit this page View Source

TimelineLimit

Timeline events per room in each sync.

Declaration
public int TimelineLimit { get; set; }
Property Value
Type Description
int
| Edit this page View Source

UserId

Full user ID, e.g. @alice:matrix.org; required, as it selects the local database.

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

Implements