Class RoomHistory

Room history for other servers, which fill gaps with it before they can show new events: missing events, backfill, single events and the state at an event.

Inheritance

object

RoomHistory

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Uniform.Matrix.Server.Federation

Assembly: Uniform.Matrix.Server.dll

Syntax

public sealed class RoomHistory

Remarks

Only servers with a member joined to the room get its history; events are returned in the PDU format they are stored in.

Constructors

RoomHistory(IDbContextFactory<ServerDbContext>, RoomAcls)

Create the service.

Declaration

public RoomHistory(IDbContextFactory<ServerDbContext> contexts, RoomAcls acls)

Parameters

Type	Name	Description
IDbContextFactory<ServerDbContext>	contexts
RoomAcls	acls

Methods

BackfillAsync(string, string, IReadOnlyCollection<string>, int, CancellationToken)

Return from and the events before them, at most limit, newest first, as backfill answers.

Declaration

public Task<JsonArray> BackfillAsync(string origin, string roomId, IReadOnlyCollection<string> from, int limit, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	origin
string	roomId
IReadOnlyCollection<string>	from
int	limit
CancellationToken	cancellationToken

Returns

Type	Description
Task<JsonArray>

GetEventAsync(string, string, CancellationToken)

Return one event of a room the asking server is in.

Declaration

public Task<JsonObject> GetEventAsync(string origin, string eventId, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	origin
string	eventId
CancellationToken	cancellationToken

Returns

Type	Description
Task<JsonObject>

GetMissingEventsAsync(string, string, IReadOnlyCollection<string>, IReadOnlyCollection<string>, int, long, CancellationToken)

Return the events before latest back to earliest, which the asking server has, at most limit, oldest first.

Declaration

public Task<JsonArray> GetMissingEventsAsync(string origin, string roomId, IReadOnlyCollection<string> earliest, IReadOnlyCollection<string> latest, int limit, long minDepth, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	origin
string	roomId
IReadOnlyCollection<string>	earliest
IReadOnlyCollection<string>	latest
int	limit
long	minDepth
CancellationToken	cancellationToken

Returns

Type	Description
Task<JsonArray>

GetStateAsync(string, string, string, CancellationToken)

Return the state of a room at an event, that is before it as other servers expect, and the auth chain of that state, as IDs or as events.

Declaration

public Task<(List<JsonObject> State, List<JsonObject> AuthChain, List<string> StateIds, List<string> AuthChainIds)> GetStateAsync(string origin, string roomId, string eventId, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	origin
string	roomId
string	eventId
CancellationToken	cancellationToken

Returns

Type	Description
Task<(List<JsonObject> State, List<JsonObject> AuthChain, List<string> StateIds, List<string> AuthChainIds)>