From a7752c3f64834e91ac7ef4590cf94e53764b9097 Mon Sep 17 00:00:00 2001
From: Hamid Reza Mohammadi <mohammadi.hr@gmail.com>
Date: Sun, 9 Jan 2022 17:59:52 +0330
Subject: [PATCH] docs: #272 IUserVisitsTrackingService interface added

---
 RMuseum/RMuseum.xml                           | 39 +++++++++++++++-
 .../Services/IUserVisitsTrackingService.cs    | 45 +++++++++++++++++++
 .../UserVisitsTrackingService.cs              |  4 +-
 3 files changed, 85 insertions(+), 3 deletions(-)
 create mode 100644 RMuseum/Services/IUserVisitsTrackingService.cs

diff --git a/RMuseum/RMuseum.xml b/RMuseum/RMuseum.xml
index c2c12210..ce851c80 100644
--- a/RMuseum/RMuseum.xml
+++ b/RMuseum/RMuseum.xml
@@ -12684,7 +12684,7 @@
         </member>
         <member name="T:RMuseum.Services.Implementation.UserVisitsTrackingService">
             <summary>
-            User Visits Tracking Service
+            User Visits Tracking Service Implementation
             </summary>
         </member>
         <member name="M:RMuseum.Services.Implementation.UserVisitsTrackingService.AddAsync(System.Guid,System.Int32)">
@@ -13499,6 +13499,43 @@
             </summary>
             <returns></returns>
         </member>
+        <member name="T:RMuseum.Services.IUserVisitsTrackingService">
+            <summary>
+            User Visits Tracking Service
+            </summary>
+        </member>
+        <member name="M:RMuseum.Services.IUserVisitsTrackingService.AddAsync(System.Guid,System.Int32)">
+            <summary>
+            add record
+            </summary>
+            <param name="userId"></param>
+            <param name="poemId"></param>
+            <returns></returns>
+        </member>
+        <member name="M:RMuseum.Services.IUserVisitsTrackingService.DeleteAsync(System.Guid,System.Guid)">
+            <summary>
+            delete record
+            </summary>
+            <param name="userId"></param>
+            <param name="recordId"></param>
+            <returns></returns>
+        </member>
+        <member name="M:RMuseum.Services.IUserVisitsTrackingService.SwitchTrackingAsync(System.Guid,System.Boolean)">
+            <summary>
+            start or stop tracking user
+            </summary>
+            <param name="userId"></param>
+            <param name="start"></param>
+            <returns></returns>
+        </member>
+        <member name="M:RMuseum.Services.IUserVisitsTrackingService.GetUserHistory(RSecurityBackend.Models.Generic.PagingParameterModel,System.Guid)">
+            <summary>
+            get user history
+            </summary>
+            <param name="paging"></param>
+            <param name="userId"></param>
+            <returns></returns>
+        </member>
         <member name="P:RMuseum.WebServiceUrl.Url">
             <summary>
             url
diff --git a/RMuseum/Services/IUserVisitsTrackingService.cs b/RMuseum/Services/IUserVisitsTrackingService.cs
new file mode 100644
index 00000000..c8299179
--- /dev/null
+++ b/RMuseum/Services/IUserVisitsTrackingService.cs
@@ -0,0 +1,45 @@
+using RMuseum.Models.Ganjoor.ViewModels;
+using RSecurityBackend.Models.Generic;
+using System;
+using System.Threading.Tasks;
+
+namespace RMuseum.Services
+{
+    /// <summary>
+    /// User Visits Tracking Service
+    /// </summary>
+    public interface IUserVisitsTrackingService
+    {
+        /// <summary>
+        /// add record
+        /// </summary>
+        /// <param name="userId"></param>
+        /// <param name="poemId"></param>
+        /// <returns></returns>
+        Task<RServiceResult<bool>> AddAsync(Guid userId, int poemId);
+
+        /// <summary>
+        /// delete record
+        /// </summary>
+        /// <param name="userId"></param>
+        /// <param name="recordId"></param>
+        /// <returns></returns>
+        Task<RServiceResult<bool>> DeleteAsync(Guid userId, Guid recordId);
+
+        /// <summary>
+        /// start or stop tracking user
+        /// </summary>
+        /// <param name="userId"></param>
+        /// <param name="start"></param>
+        /// <returns></returns>
+        Task<RServiceResult<bool>> SwitchTrackingAsync(Guid userId, bool start);
+
+        /// <summary>
+        /// get user history
+        /// </summary>
+        /// <param name="paging"></param>
+        /// <param name="userId"></param>
+        /// <returns></returns>
+        Task<RServiceResult<(PaginationMetadata PagingMeta, GanjoorUserBookmarkViewModel[] HistoryItems)>> GetUserHistory(PagingParameterModel paging, Guid userId);
+    }
+}
diff --git a/RMuseum/Services/Implementation/UserVisitsTrackingService.cs b/RMuseum/Services/Implementation/UserVisitsTrackingService.cs
index 69087a89..c5295cdf 100644
--- a/RMuseum/Services/Implementation/UserVisitsTrackingService.cs
+++ b/RMuseum/Services/Implementation/UserVisitsTrackingService.cs
@@ -13,9 +13,9 @@ using System.Threading.Tasks;
 namespace RMuseum.Services.Implementation
 {
     /// <summary>
-    /// User Visits Tracking Service
+    /// User Visits Tracking Service Implementation
     /// </summary>
-    public class UserVisitsTrackingService
+    public class UserVisitsTrackingService : IUserVisitsTrackingService
     {
         /// <summary>
         /// add record