docs: #272 IUserVisitsTrackingService interface added

This commit is contained in:
Hamid Reza Mohammadi 2022-01-09 17:59:52 +03:30
parent ede632acf3
commit a7752c3f64
3 changed files with 85 additions and 3 deletions

View File

@ -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

View File

@ -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);
}
}

View File

@ -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