extends XResourceProvider and it's Related Requirements ...

2026-05-29 19:33:59 +03:30
parent 49e3f0af7b
commit 4f7e1e1586
9 changed files with 2098 additions and 0 deletions
@@ -0,0 +1,128 @@
+using System.Collections.Generic;
+using System.Threading;
+using System.Threading.Tasks;
+using Microsoft.AspNetCore.Mvc;
+using xModels.Dtos;
+using xPushService.Interfaces;
+using xStringService.Models.Dtos;
+using xStringService.Models.Entities;
+using xStringService.Providers.Dtos;
+
+namespace xStringService.Interfaces
+{
+    public interface IXStringProviderController : IXBaseProvidedController<XString, XStringDto, int, XStringDtoHub>
+    {
+        //
+        #region Tools ...
+        /// <summary>
+        /// Retrieve a List of Exists Languages ...
+        /// </summary>
+        /// <param name="cancellationToken"></param>
+        /// <returns></returns>
+        [HttpGet("Languages")]
+        Task<ActionResult<IEnumerable<string>>> GetLanguages(
+            CancellationToken cancellationToken = default
+        );
+
+        /// <summary>
+        /// Retrieve a List of Resource Titles ...
+        /// </summary>
+        /// <param name="language">if provided, returns all language Specified resource titles, if not, all Resource Titles</param>
+        /// <param name="cancellationToken"></param>
+        /// <returns></returns>
+        [HttpGet("ResourceTitles")]
+        Task<ActionResult<IEnumerable<string>>> GetResourceTitles(
+            [FromQuery] string language = null,
+            CancellationToken cancellationToken = default
+        );
+
+        /// <summary>
+        /// Retrieve all Exists Items which belongs to Specified Resource Title ...
+        /// </summary>
+        /// <param name="resource">Specified Resource Title</param>
+        /// <param name="cancellationToken"></param>
+        /// <returns></returns>
+        [HttpGet("ResourceLocales")]
+        Task<ActionResult<IEnumerable<XStringDto>>> GetResourceLocales(
+            [FromQuery] string resource,
+            CancellationToken cancellationToken = default
+        );
+
+        /// <summary>
+        /// Extract Translation of a Resource in Specified Language ...
+        /// </summary>
+        /// <param name="language">Specified Language ...</param>
+        /// <param name="resource">Specified Resource Title ...</param>
+        /// <param name="cancellationToken"></param>
+        /// <returns></returns>
+        [HttpGet("Translation")]
+        Task<ActionResult<string>> GetResourceTranslation(
+            [FromQuery] string language,
+            [FromQuery] string resource,
+            CancellationToken cancellationToken = default
+        );
+
+        /// <summary>
+        /// Retrieve a Resource as Locale Model ...
+        /// </summary>
+        /// <param name="language">Specified Language ...</param>
+        /// <param name="resource">Specified Resource Title ...</param>
+        /// <param name="cancellationToken"></param>
+        /// <returns></returns>
+        [HttpGet("Locale")]
+        Task<ActionResult<XLocaleResourceDto>> GetLocale(
+            [FromQuery] string language,
+            [FromQuery] string resource,
+            CancellationToken cancellationToken = default
+        );
+
+        /// <summary>
+        /// Retrieve all Exists Resource Instances as Locale Models ...
+        /// </summary>
+        /// <param name="resource"></param>
+        /// <param name="cancellationToken"></param>
+        /// <returns></returns>
+        [HttpGet("Locales")]
+        Task<ActionResult<IEnumerable<XLocaleResourceDto>>> GetLocales(
+            [FromQuery] string resource,
+            CancellationToken cancellationToken = default
+        );
+
+        /// <summary>
+        /// Retrieve all Locales of Specified Resource and Represent as XResourceDto ...
+        /// </summary>
+        /// <param name="resource"></param>
+        /// <param name="cancellationToken"></param>
+        /// <returns></returns>
+        [HttpGet("GetResource")]
+        Task<ActionResult<XResourceDto>> GetResource(
+            [FromQuery] string resource,
+            CancellationToken cancellationToken = default
+        );
+
+        /// <summary>
+        /// Add or Update a Resource Model ...
+        /// </summary>
+        /// <param name="resource">a XResourceDto Model ...</param>
+        /// <param name="cancellationToken"></param>
+        /// <returns></returns>
+        [HttpPost("AddOrUpdateResource")]
+        Task<ActionResult<XResourceDto>> AddOrUpdateResource(
+            [FromBody] XResourceDto resource,
+            CancellationToken cancellationToken = default
+        );
+
+        /// <summary>
+        /// Remove Specified Resource Model ...
+        /// </summary>
+        /// <param name="resource">a XResourceDto Model ...</param>
+        /// <param name="cancellationToken"></param>
+        /// <returns></returns>
+        [HttpPost("RemoveResource")]
+        Task<ActionResult> RemoveResource(
+            [FromBody] XResourceDto resource,
+            CancellationToken cancellationToken = default
+        );
+        #endregion
+    }
+}