From da9139b7bab95f6e5ba5f4bb2d99011c2d6db03a Mon Sep 17 00:00:00 2001
From: crupest <crupest@outlook.com>
Date: Wed, 23 Mar 2022 21:30:14 +0800
Subject: …
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 .../Timeline/Services/Token/IUserTokenService.cs   | 45 ++++++++++++++++++++++
 1 file changed, 45 insertions(+)
 create mode 100644 BackEnd/Timeline/Services/Token/IUserTokenService.cs

(limited to 'BackEnd/Timeline/Services/Token/IUserTokenService.cs')

diff --git a/BackEnd/Timeline/Services/Token/IUserTokenService.cs b/BackEnd/Timeline/Services/Token/IUserTokenService.cs
new file mode 100644
index 00000000..22fb0fb4
--- /dev/null
+++ b/BackEnd/Timeline/Services/Token/IUserTokenService.cs
@@ -0,0 +1,45 @@
+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>
+        /// <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 the token is expired.</exception>
+        Task<UserTokenInfo> ValidateTokenAsync(string token);
+
+        /// <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);
+    }
+}
-- 
cgit v1.2.3