blob: a9689f57d6e0f86a1ba1e649e55f05827918eb27 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
|
using System;
using System.Threading.Tasks;
namespace Timeline.Services.Token
{
public interface IUserTokenService
{
/// <summary>
/// Create a token for a user. Please ensure the user id exists!
/// </summary>
/// <param name="userId">The user id.</param>
/// <param name="expireTime">The expire time of the token.</param>
/// <returns>Return the generated token.</returns>
Task<string> CreateTokenAsync(long userId, DateTime? expireTime);
/// <summary>
/// Verify a token and get the info of the token.
/// </summary>
/// <param name="token">The token to verify.</param>
/// <param name="checkLifetime">Whether to check lifetime of token.</param>
/// <returns>The info of the token.</returns>
/// <exception cref="ArgumentNullException">Thrown when <paramref name="token"/> is null.</exception>
/// <exception cref="UserTokenException">Thrown when the token is not valid for reasons other than expired.</exception>
/// <exception cref="UserTokenExpiredException">Thrown when <paramref name="checkLifetime"/> is true and the token is expired.</exception>
Task<UserTokenInfo> ValidateTokenAsync(string token, bool checkLifetime = true);
/// <summary>
/// Revoke a token to make it no longer valid.
/// </summary>
/// <param name="token">The token to revoke.</param>
/// <returns>Return true if a token is revoked.</returns>
/// <exception cref="ArgumentNullException">Thrown when <paramref name="token"/> is null.</exception>
/// <remarks>
/// This method returns true if a real token is revoked and returns false if the token is not valid.
/// If the token is expired, false is return.
/// </remarks>
Task<bool> RevokeTokenAsync(string token);
/// <summary>
/// Revoke all tokens of a user.
/// </summary>
/// <param name="userId">User id of tokens.</param>
/// <returns>Return the task.</returns>
Task RevokeAllTokenByUserIdAsync(long userId);
}
}
|
