Class AccountService

Local accounts, devices and access tokens.

Inheritance

object

AccountService

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 AccountService

Constructors

| Edit this page View Source

AccountService(IDbContextFactory<ServerDbContext>, IOptions<ServerOptions>, TimeProvider, DeviceKeyService)

Create the service over the database.

Declaration

public AccountService(IDbContextFactory<ServerDbContext> contexts, IOptions<ServerOptions> options, TimeProvider time, DeviceKeyService keys)

Parameters

Type	Name	Description
IDbContextFactory<ServerDbContext>	contexts
IOptions<ServerOptions>	options
TimeProvider	time
DeviceKeyService	keys

Properties

| Edit this page View Source

ServerName

Server name of local user IDs.

Declaration

public string ServerName { get; }

Property Value

Type	Description
string

Methods

| Edit this page View Source

AuthenticateAsync(string, string?, CancellationToken)

Return the user and device of an access token, or null when unknown; record when the device was last seen.

Declaration

public Task<Requester?> AuthenticateAsync(string token, string? address, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	token
string	address
CancellationToken	cancellationToken

Returns

Type	Description
Task<Requester>

| Edit this page View Source

ChangePasswordAsync(string, string, string?, CancellationToken)

Set a new password; with keepDeviceId, logs out every other device.

Declaration

public Task ChangePasswordAsync(string userId, string newPassword, string? keepDeviceId, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	userId
string	newPassword
string	keepDeviceId
CancellationToken	cancellationToken

Returns

Type	Description
Task

| Edit this page View Source

CheckPasswordAsync(string, string, CancellationToken)

Return whether password is the password of an active account.

Declaration

public Task<bool> CheckPasswordAsync(string userId, string password, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	userId
string	password
CancellationToken	cancellationToken

Returns

Type	Description
Task<bool>

| Edit this page View Source

DeleteDevicesAsync(string, IReadOnlyCollection<string>, CancellationToken)

Delete devices of userId with their tokens, pushers, keys and waiting messages; unknown device IDs are ignored.

Declaration

public Task DeleteDevicesAsync(string userId, IReadOnlyCollection<string> deviceIds, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	userId
IReadOnlyCollection<string>	deviceIds
CancellationToken	cancellationToken

Returns

Type	Description
Task

| Edit this page View Source

GetDeviceAsync(string, string, CancellationToken)

Return one device; throw M_NOT_FOUND when the user has no such device.

Declaration

public Task<Device> GetDeviceAsync(string userId, string deviceId, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	userId
string	deviceId
CancellationToken	cancellationToken

Returns

Type	Description
Task<Device>

| Edit this page View Source

GetDevicesAsync(string, CancellationToken)

Return the devices of userId.

Declaration

public Task<IReadOnlyList<Device>> GetDevicesAsync(string userId, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	userId
CancellationToken	cancellationToken

Returns

Type	Description
Task<IReadOnlyList<Device>>

| Edit this page View Source

IsAvailableAsync(string, CancellationToken)

Return whether localpart is free; throw M_INVALID_USERNAME when it is not valid.

Declaration

public Task<bool> IsAvailableAsync(string localpart, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	localpart
CancellationToken	cancellationToken

Returns

Type	Description
Task<bool>

| Edit this page View Source

LockedError()

Error of a failed login.

Declaration

public static MatrixErrorException LockedError()

Returns

Type	Description
MatrixErrorException

| Edit this page View Source

LoginAsync(string, string, string?, string?, CancellationToken)

Declaration

public Task<LoginResponse> LoginAsync(string user, string password, string? deviceId, string? deviceName, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	user
string	password
string	deviceId
string	deviceName
CancellationToken	cancellationToken

Returns

Type	Description
Task<LoginResponse>

| Edit this page View Source

LogoutAllAsync(string, CancellationToken)

End every session of userId.

Declaration

public Task LogoutAllAsync(string userId, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	userId
CancellationToken	cancellationToken

Returns

Type	Description
Task

| Edit this page View Source

LogoutAsync(Requester, CancellationToken)

End the session of requester: its token and device.

Declaration

public Task LogoutAsync(Requester requester, CancellationToken cancellationToken)

Parameters

Type	Name	Description
Requester	requester
CancellationToken	cancellationToken

Returns

Type	Description
Task

| Edit this page View Source

RegisterAsync(string?, string?, string?, string?, bool, bool, CancellationToken)

Create an account, and unless inhibitLogin a device with an access token; throw M_USER_IN_USE when taken.

Declaration

public Task<RegisterResponse> RegisterAsync(string? localpart, string? password, string? deviceId, string? deviceName, bool inhibitLogin, bool admin, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	localpart	Wanted localpart, or null for a generated one.
string	password	Password, or null for an account that cannot log in with one.
string	deviceId	Device to create, or null for a generated one.
string	deviceName	Display name of the device.
bool	inhibitLogin	Whether to create only the account.
bool	admin	Whether the user administers the server.
CancellationToken	cancellationToken	Cancellation token.

Returns

Type	Description
Task<RegisterResponse>

| Edit this page View Source

RenameDeviceAsync(string, string, string?, CancellationToken)

Rename a device; throw M_NOT_FOUND when the user has no such device.

Declaration

public Task RenameDeviceAsync(string userId, string deviceId, string? displayName, CancellationToken cancellationToken)

Parameters

Type	Name	Description
string	userId
string	deviceId
string	displayName
CancellationToken	cancellationToken

Returns

Type	Description
Task