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,142 @@
+using System.Collections.Generic;
+using System.Threading;
+using System.Threading.Tasks;
+using xIdentityModels.Models;
+using xModels.Dtos;
+using xStringService.Models.Dtos;
+
+namespace xStringService.Interfaces
+{
+    public interface IXResourceProvider
+    {
+        /// <summary>
+        /// Retrieve a List of Exists Languages ...
+        /// </summary>
+        /// <param name="cancellationToken"></param>
+        /// <returns></returns>
+        Task<IEnumerable<string>> GetLanguages(
+            CancellationToken cancellationToken = default
+        );
+
+        /// <summary>
+        /// Retrieve all Exists Items ...
+        /// </summary>
+        /// <param name="resource">Specified Resource Title</param>
+        /// <param name="cancellationToken"></param>
+        /// <returns></returns>
+        Task<IEnumerable<XStringDto>> GetResourceLocales(
+            CancellationToken cancellationToken = default
+        );
+
+        /// <summary>
+        /// Extract Translation of in Specified Language ...
+        /// </summary>
+        /// <param name="language">Specified Language ...</param>
+        /// <param name="cancellationToken"></param>
+        /// <returns></returns>
+        Task<string> GetResourceTranslation(
+            string language,
+            CancellationToken cancellationToken = default
+        );
+
+        /// <summary>
+        /// Check Has Specified Translation or not ...
+        /// </summary>
+        /// <param name="language">Specified Language ...</param>
+        /// <param name="cancellationToken"></param>
+        /// <returns></returns>
+        Task<bool> HasLocale(
+            string language,
+            CancellationToken cancellationToken = default
+        );
+
+        /// <summary>
+        /// Retrieve as Locale Model ...
+        /// </summary>
+        /// <param name="language">Specified Language ...</param>
+        /// <param name="cancellationToken"></param>
+        /// <returns></returns>
+        Task<XLocaleResourceDto> GetLocale(
+            string language,
+            CancellationToken cancellationToken = default
+        );
+
+        /// <summary>
+        /// Retrieve all Exists Locale Models ...
+        /// </summary>
+        /// <param name="cancellationToken"></param>
+        /// <returns></returns>
+        Task<IEnumerable<XLocaleResourceDto>> GetLocales(
+            CancellationToken cancellationToken = default
+        );
+
+        /// <summary>
+        /// Retrieve as XResourceDto ...
+        /// </summary>
+        /// <param name="cancellationToken"></param>
+        /// <returns></returns>
+        Task<XResourceDto> GetResource(
+            CancellationToken cancellationToken = default
+        );
+
+        /// <summary>
+        /// Add or Update a Resource Model ...
+        /// </summary>
+        /// <param name="resource">a XResourceDto Model ...</param>
+        /// <param name="userInfo">Actor User for Permissions ...</param>
+        /// <param name="connectionId"></param>
+        /// <param name="cancellationToken"></param>
+        /// <returns></returns>
+        Task<XResourceDto> AddOrUpdateResource(
+            XResourceDto resource,
+            XUserClaimsInfoDto userInfo = null,
+            string connectionId = null,
+            CancellationToken cancellationToken = default
+        );
+
+        /// <summary>
+        /// Add Or Update Locale ...
+        /// </summary>
+        /// <param name="locale"></param>
+        /// <param name="userInfo">Actor User for Permissions ...</param>
+        /// <param name="connectionId"></param>
+        /// <param name="cancellationToken"></param>
+        /// <returns></returns>
+        Task<XResourceDto> AddOrUpdateLocale(
+            XLocaleResourceDto locale,
+            XUserClaimsInfoDto userInfo = null,
+            string connectionId = null,
+            CancellationToken cancellationToken = default
+        );
+
+        /// <summary>
+        /// Remove Locale ...
+        /// </summary>
+        /// <param name="locale"></param>
+        /// <param name="userInfo">Actor User for Permissions ...</param>
+        /// <param name="connectionId"></param>
+        /// <param name="cancellationToken"></param>
+        /// <returns></returns>
+        Task<XResourceDto> RemoveLocale(
+            XLocaleResourceDto locale,
+            XUserClaimsInfoDto userInfo = null,
+            string connectionId = null,
+            CancellationToken cancellationToken = default
+        );
+
+        /// <summary>
+        /// Remove Specified Resource Model ...
+        /// </summary>
+        /// <param name="resource">a XResourceDto Model ...</param>
+        /// <param name="userInfo">Actor User for Permissions ...</param>
+        /// <param name="connectionId"></param>
+        /// <param name="cancellationToken"></param>
+        /// <returns></returns>
+        Task RemoveResource(
+            XResourceDto resource,
+            XUserClaimsInfoDto userInfo = null,
+            string connectionId = null,
+            CancellationToken cancellationToken = default
+        );
+    }
+}