anas/divan
1
0
Fork 0
Code Issues 12 Pull Requests Actions Packages Projects Releases Wiki Activity

docs: #346 adding a switch-bookmark API which returns bookmark id

Browse Source
This commit is contained in:
Hamid Reza Mohammadi 2022-07-12 21:59:23 +04:30
parent 9fd3b2e601
commit 307e245638
2 changed files with 34 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
RMuseum/Controllers/GanjoorController.cs
View File

@ -2435,6 +2435,32 @@ namespace RMuseum.Controllers
}
return Ok(res.Result != null);
}
/// <summary>
/// switch bookmark and return bookmark id (0 for switching off a bookmark)
/// </summary>
/// <param name="poemId"></param>
/// <param name="coupletIndex">if you send a negative number it means you are trying to bookmark a comment</param>
/// <returns></returns>
[HttpPost]
[Route("bookmark/switch/ret/{poemId}/{coupletIndex}")]
[Authorize]
[ProducesResponseType((int)HttpStatusCode.OK, Type = typeof(bool))]
[ProducesResponseType((int)HttpStatusCode.BadRequest, Type = typeof(string))]
[ProducesResponseType((int)HttpStatusCode.NotFound)]
public async Task<IActionResult> SwitchCoupletBookmarkReturnId(int poemId, int coupletIndex)
{
if (ReadOnlyMode)
return BadRequest("سایت به دلایل فنی مثل انتقال سرور موقتاً در حالت فقط خواندنی قرار دارد. لطفاً ساعاتی دیگر مجدداً تلاش کنید.");
Guid loggedOnUserId = new Guid(User.Claims.FirstOrDefault(c => c.Type == "UserId").Value);
RServiceResult<GanjoorUserBookmark> res = await _ganjoorService.SwitchCoupletBookmark(loggedOnUserId, poemId, coupletIndex);
if (!string.IsNullOrEmpty(res.ExceptionString))
{
if (res.ExceptionString == "verse not found")
return NotFound();
return BadRequest(res.ExceptionString);
}
return Ok(res.Result == null ? 0 : res.Result.Id);
}
/// <summary>
/// Bookmark couplet if it is not

8
RMuseum/RMuseum.xml
View File

@ -1579,6 +1579,14 @@
<param name="coupletIndex">if you send a negative number it means you are trying to bookmark a comment</param>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.GanjoorController.SwitchCoupletBookmarkReturnId(System.Int32,System.Int32)">
<summary>
switch bookmark and return bookmark id (0 for switching off a bookmark)
</summary>
<param name="poemId"></param>
<param name="coupletIndex">if you send a negative number it means you are trying to bookmark a comment</param>
<returns></returns>
</member>
<member name="M:RMuseum.Controllers.GanjoorController.BookmarkCoupletIfNotBookmarked(System.Int32,System.Int32)">
<summary>
Bookmark couplet if it is not