Class SyncFilter

The parts of a sync filter the server applies.

Inheritance
object
SyncFilter
Implements
Inherited Members
Namespace: Uniform.Matrix.Server.Sync
Assembly: Uniform.Matrix.Server.dll
Syntax
public sealed record SyncFilter : IEquatable<SyncFilter>

Fields

| Edit this page View Source

Default

Filter of clients that set none.

Declaration
public static readonly SyncFilter Default
Field Value
Type Description
SyncFilter

Properties

| Edit this page View Source

IncludeLeave

Whether initial syncs include rooms the user has left.

Declaration
public bool IncludeLeave { get; init; }
Property Value
Type Description
bool
| Edit this page View Source

LazyLoadMembers

Whether state holds only the members needed for the timeline.

Declaration
public bool LazyLoadMembers { get; init; }
Property Value
Type Description
bool
| Edit this page View Source

NotRooms

Rooms to leave out.

Declaration
public IReadOnlySet<string> NotRooms { get; init; }
Property Value
Type Description
IReadOnlySet<string>
| Edit this page View Source

Rooms

Rooms to include; all when null.

Declaration
public IReadOnlySet<string>? Rooms { get; init; }
Property Value
Type Description
IReadOnlySet<string>
| Edit this page View Source

TimelineLimit

Timeline events per room; 10 by default.

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

TimelineNotTypes

Event types the timeline leaves out.

Declaration
public IReadOnlySet<string> TimelineNotTypes { get; init; }
Property Value
Type Description
IReadOnlySet<string>
| Edit this page View Source

TimelineTypes

Event types the timeline keeps; all when null.

Declaration
public IReadOnlySet<string>? TimelineTypes { get; init; }
Property Value
Type Description
IReadOnlySet<string>

Methods

| Edit this page View Source

IncludesRoom(string)

Return whether the filter includes roomId.

Declaration
public bool IncludesRoom(string roomId)
Parameters
Type Name Description
string roomId
Returns
Type Description
bool
| Edit this page View Source

IncludesType(string)

Return whether the timeline keeps events of type; a trailing * matches prefixes.

Declaration
public bool IncludesType(string type)
Parameters
Type Name Description
string type
Returns
Type Description
bool
| Edit this page View Source

Parse(JsonObject?)

Read a filter's JSON; missing parts keep their defaults.

Declaration
public static SyncFilter Parse(JsonObject? json)
Parameters
Type Name Description
JsonObject json
Returns
Type Description
SyncFilter

Implements