Class AccountDataService

A user's account data, global and per room, including room tags.

Inheritance

object

AccountDataService

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Uniform.Matrix.Server.Accounts

Assembly: Uniform.Matrix.Server.dll

Syntax

public sealed class AccountDataService

Remarks

Each change takes a ServerStream position, so incremental syncs return it.

Constructors

AccountDataService(IDbContextFactory<ServerDbContext>, ServerStream)

Create the service.

Declaration

public AccountDataService(IDbContextFactory<ServerDbContext> contexts, ServerStream stream)

Parameters

Type	Name	Description
IDbContextFactory<ServerDbContext>	contexts
ServerStream	stream

Fields

FullyReadType

Room account data type of the fully read marker.

Declaration

public const string FullyReadType = "m.fully_read"

Field Value

Type	Description
string

TagType

Room account data type of room tags.

Declaration

public const string TagType = "m.tag"

Field Value

Type	Description
string

Methods

DeleteTagAsync(string, string, string, CancellationToken)

Remove a tag of a room; removing a missing tag does nothing.

Declaration

public Task DeleteTagAsync(string userId, string roomId, string tag, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	userId
string	roomId
string	tag
CancellationToken	cancellationToken

Returns

Type	Description
Task

GetAsync(string, string?, string, CancellationToken)

Return account data content; throw M_NOT_FOUND when not set.

Declaration

public Task<JsonObject> GetAsync(string userId, string? roomId, string type, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	userId
string	roomId
string	type
CancellationToken	cancellationToken

Returns

Type	Description
Task<JsonObject>

GetTagsAsync(string, string, CancellationToken)

Return the room's tags, e.g. {"m.favourite":{"order":0.5}}.

Declaration

public Task<JsonObject> GetTagsAsync(string userId, string roomId, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	userId
string	roomId
CancellationToken	cancellationToken

Returns

Type	Description
Task<JsonObject>

SetAsync(string, string?, string, JsonObject, CancellationToken)

Set account data; roomId is null for global data.

Declaration

public Task SetAsync(string userId, string? roomId, string type, JsonObject content, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	userId
string	roomId
string	type
JsonObject	content
CancellationToken	cancellationToken

Returns

Type	Description
Task

SetFromClientAsync(string, string?, string, JsonObject, CancellationToken)

Set account data from a client; roomId is null for global data. Throws M_BAD_JSON for types the server controls.

Declaration

public Task SetFromClientAsync(string userId, string? roomId, string type, JsonObject content, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	userId
string	roomId
string	type
JsonObject	content
CancellationToken	cancellationToken

Returns

Type	Description
Task

SetTagAsync(string, string, string, JsonObject, CancellationToken)

Add or replace a tag of a room; info holds its optional order.

Declaration

public Task SetTagAsync(string userId, string roomId, string tag, JsonObject info, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	userId
string	roomId
string	tag
JsonObject	info
CancellationToken	cancellationToken

Returns

Type	Description
Task

TryGetAsync(string, string?, string, CancellationToken)

Return account data content, or null when not set; roomId is null for global data.

Declaration

public Task<JsonObject?> TryGetAsync(string userId, string? roomId, string type, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	userId
string	roomId
string	type
CancellationToken	cancellationToken

Returns

Type	Description
Task<JsonObject>