From ac309245d21f16c06abe2d1d9bb260e094d0805e Mon Sep 17 00:00:00 2001
From: crupest <crupest@outlook.com>
Date: Tue, 27 Apr 2021 19:37:11 +0800
Subject: refactor: ...

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

(limited to 'BackEnd/Timeline/Services/User/Avatar/IUserAvatarService.cs')

diff --git a/BackEnd/Timeline/Services/User/Avatar/IUserAvatarService.cs b/BackEnd/Timeline/Services/User/Avatar/IUserAvatarService.cs
new file mode 100644
index 00000000..fda35aac
--- /dev/null
+++ b/BackEnd/Timeline/Services/User/Avatar/IUserAvatarService.cs
@@ -0,0 +1,45 @@
+using System;
+using System.Threading.Tasks;
+using Timeline.Helpers.Cache;
+using Timeline.Models;
+using Timeline.Services.Imaging;
+
+namespace Timeline.Services.User.Avatar
+{
+    public interface IUserAvatarService
+    {
+        /// <summary>
+        /// Get avatar digest of a user.
+        /// </summary>
+        /// <param name="userId">User id.</param>
+        /// <returns>The avatar digest.</returns>
+        /// <exception cref="UserNotExistException">Thrown when user does not exist.</exception>
+        Task<ICacheableDataDigest> GetAvatarDigest(long userId);
+
+        /// <summary>
+        /// Get avatar of a user. If the user has no avatar set, a default one is returned.
+        /// </summary>
+        /// <param name="userId">User id.</param>
+        /// <returns>The avatar.</returns>
+        /// <exception cref="UserNotExistException">Thrown when user does not exist.</exception>
+        Task<ByteData> GetAvatar(long userId);
+
+        /// <summary>
+        /// Set avatar for a user.
+        /// </summary>
+        /// <param name="userId">User id.</param>
+        /// <param name="avatar">The new avatar data.</param>
+        /// <returns>The digest of the avatar.</returns>
+        /// <exception cref="ArgumentNullException">Thrown if <paramref name="avatar"/> is null.</exception>
+        /// <exception cref="UserNotExistException">Thrown when user does not exist.</exception>
+        /// <exception cref="ImageException">Thrown if avatar is of bad format.</exception>
+        Task<ICacheableDataDigest> SetAvatar(long userId, ByteData avatar);
+
+        /// <summary>
+        /// Remove avatar of a user.
+        /// </summary>
+        /// <param name="userId">User id.</param>
+        /// <exception cref="UserNotExistException">Thrown when user does not exist.</exception>
+        Task DeleteAvatar(long userId);
+    }
+}
-- 
cgit v1.2.3