Class RegistrationTokens

Registration tokens: those in RegistrationTokens, which never run out, and those admins create in the database, with a number of uses and an expiry.

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

A token's use is counted when a registration passes the token stage, so a registration abandoned after it still uses it up.

Constructors

| Edit this page View Source

RegistrationTokens(IDbContextFactory<ServerDbContext>, IOptionsMonitor<ServerOptions>, TimeProvider, ILogger<RegistrationTokens>)

Create the service.

Declaration
public RegistrationTokens(IDbContextFactory<ServerDbContext> contexts, IOptionsMonitor<ServerOptions> options, TimeProvider time, ILogger<RegistrationTokens> logger)
Parameters
Type Name Description
IDbContextFactory<ServerDbContext> contexts
IOptionsMonitor<ServerOptions> options
TimeProvider time
ILogger<RegistrationTokens> logger

Methods

| Edit this page View Source

CreateAsync(string?, int, int?, long?, CancellationToken)

Create a token: token, or a random one of length characters.

Declaration
public Task<RegistrationToken> CreateAsync(string? token, int length, int? usesAllowed, long? expiryTime, CancellationToken cancellationToken)
Parameters
Type Name Description
string token
int length
int? usesAllowed
long? expiryTime
CancellationToken cancellationToken
Returns
Type Description
Task<RegistrationToken>
| Edit this page View Source

DeleteAsync(string, CancellationToken)

Delete a stored token.

Declaration
public Task DeleteAsync(string token, CancellationToken cancellationToken)
Parameters
Type Name Description
string token
CancellationToken cancellationToken
Returns
Type Description
Task
| Edit this page View Source

GetAllAsync(bool?, CancellationToken)

Return the stored tokens; with valid, only those that may or may not register now.

Declaration
public Task<IReadOnlyList<RegistrationToken>> GetAllAsync(bool? valid, CancellationToken cancellationToken)
Parameters
Type Name Description
bool? valid
CancellationToken cancellationToken
Returns
Type Description
Task<IReadOnlyList<RegistrationToken>>
| Edit this page View Source

GetAsync(string, CancellationToken)

Return a stored token; throw M_NOT_FOUND when unknown.

Declaration
public Task<RegistrationToken> GetAsync(string token, CancellationToken cancellationToken)
Parameters
Type Name Description
string token
CancellationToken cancellationToken
Returns
Type Description
Task<RegistrationToken>
| Edit this page View Source

IsValidAsync(string?, CancellationToken)

Return whether token may register now: a configured one, or a stored one with uses left that has not expired.

Declaration
public Task<bool> IsValidAsync(string? token, CancellationToken cancellationToken)
Parameters
Type Name Description
string token
CancellationToken cancellationToken
Returns
Type Description
Task<bool>
| Edit this page View Source

UpdateAsync(string, Optional<int?>, Optional<long?>, CancellationToken)

Change the uses or expiry of a token; a field not given stays as it is.

Declaration
public Task<RegistrationToken> UpdateAsync(string token, Optional<int?> usesAllowed, Optional<long?> expiryTime, CancellationToken cancellationToken)
Parameters
Type Name Description
string token
Optional<int?> usesAllowed
Optional<long?> expiryTime
CancellationToken cancellationToken
Returns
Type Description
Task<RegistrationToken>
| Edit this page View Source

UseAsync(string?, CancellationToken)

Use token for a registration; return false when it is not valid. Stored tokens count the use.

Declaration
public Task<bool> UseAsync(string? token, CancellationToken cancellationToken)
Parameters
Type Name Description
string token
CancellationToken cancellationToken
Returns
Type Description
Task<bool>