Class ProfileService

Profiles: display name and avatar of local users, and of other servers' users through federation.

Inheritance
object
ProfileService
Inherited Members
Namespace: Uniform.Matrix.Server.Accounts
Assembly: Uniform.Matrix.Server.dll
Syntax
public sealed class ProfileService
Remarks

Changing a profile also updates the user's member event in each joined room, as other members see names from there.

Constructors

| Edit this page View Source

ProfileService(IDbContextFactory<ServerDbContext>, RoomService, FederationClient, IOptionsMonitor<ServerOptions>)

Create the service.

Declaration
public ProfileService(IDbContextFactory<ServerDbContext> contexts, RoomService rooms, FederationClient federation, IOptionsMonitor<ServerOptions> server)
Parameters
Type Name Description
IDbContextFactory<ServerDbContext> contexts
RoomService rooms
FederationClient federation
IOptionsMonitor<ServerOptions> server

Fields

| Edit this page View Source

AvatarUrl

Profile field of the avatar.

Declaration
public const string AvatarUrl = "avatar_url"
Field Value
Type Description
string
| Edit this page View Source

DisplayName

Profile field of the display name.

Declaration
public const string DisplayName = "displayname"
Field Value
Type Description
string

Methods

| Edit this page View Source

GetFieldAsync(string, string, CancellationToken)

Return one field of a profile; throw M_NOT_FOUND when it is not set.

Declaration
public Task<JsonObject> GetFieldAsync(string userId, string field, CancellationToken cancellationToken)
Parameters
Type Name Description
string userId
string field
CancellationToken cancellationToken
Returns
Type Description
Task<JsonObject>
| Edit this page View Source

GetProfileAsync(string, CancellationToken)

Return the profile of a user, with unset fields left out; throw M_NOT_FOUND for unknown users. Users of other servers are asked from their server.

Declaration
public Task<JsonObject> GetProfileAsync(string userId, CancellationToken cancellationToken)
Parameters
Type Name Description
string userId
CancellationToken cancellationToken
Returns
Type Description
Task<JsonObject>
| Edit this page View Source

SetFieldAsync(string, string, string?, CancellationToken)

Set or clear (value null or empty) the requester's display name or avatar, then update their rooms.

Declaration
public Task SetFieldAsync(string userId, string field, string? value, CancellationToken cancellationToken)
Parameters
Type Name Description
string userId
string field
string value
CancellationToken cancellationToken
Returns
Type Description
Task