xStringService/Interfaces/IXBaseStringResourceProvider.cs

using System.Collections.Generic;
using System.Threading;
using System.Threading.Tasks;
using xCommons.Configurations;
using xModels.Dtos;
using xStringService.Interfaces.Dtos;
using xStringService.Models.Dtos;

namespace xStringService.Interfaces
{
    /// <summary>
    /// a Base Class for Handling Resources Based on Specified Types on
    /// String Resources Use ...
    /// such as:
    /// - Terms and Conditions;
    /// - Contents;
    /// - News;
    /// - etc ...
    /// </summary>
    public interface IXBaseStringResourceProvider
    {
        //
        #region Props ...
        string Prefix { get; }
        IXStringServiceProvider Provider { get; }
        XAppConfiguration AppConfiguration { get; }
        #endregion

        //
        #region Actions ...
        /// <summary>
        /// Prepare Resource Title by Given Data ...
        /// </summary>
        /// <param name="suffix"></param>
        /// <returns></returns>
        string GetResourceTitle(string suffix);

        /// <summary>
        /// Add Specified Locales ...
        /// </summary>
        /// <param name="suffix"></param>
        /// <param name="locales"></param>
        /// <param name="connectionId"></param>
        /// <param name="cancellationToken"></param>
        /// <returns></returns>
        Task<IEnumerable<XStringDto>> Add(
            string suffix,
            IEnumerable<XLocaleResourceDto> locales,
            string connectionId = null,
            CancellationToken cancellationToken = default
        );

        /// <summary>
        /// Add Or Update Specified Locals ...
        /// </summary>
        /// <param name="resource"></param>
        /// <param name="locales"></param>
        /// <param name="connectionId"></param>
        /// <param name="cancellationToken"></param>
        /// <returns></returns>
        Task<IEnumerable<XStringDto>> AddOrUpdate(
            string resource,
            IEnumerable<XLocaleResourceDto> locales,
            string connectionId = null,
            CancellationToken cancellationToken = default
        );

        /// <summary>
        /// Get Specified Locale ...
        /// </summary>
        /// <param name="suffix"></param>
        /// <param name="language"></param>
        /// <param name="cancellationToken"></param>
        /// <returns></returns>
        Task<XLocaleResourceDto> GetLocale(
            string suffix,
            string language = null,
            CancellationToken cancellationToken = default
        );

        /// <summary>
        /// Add Specified Resource ...
        /// </summary>
        /// <param name="suffix"></param>
        /// <param name="item"></param>
        /// <param name="connectionId"></param>
        /// <param name="cancellationToken"></param>
        /// <returns></returns>
        Task<XResourceDto> AddResource(
            string suffix,
            XResourceDto item,
            string connectionId = null,
            CancellationToken cancellationToken = default
        );

        /// <summary>
        /// Get Resources of Specified Resource ...
        /// </summary>
        /// <param name="suffix"></param>
        /// <param name="cancellationToken"></param>
        /// <returns></returns>
        Task<XResourceDto> GetResource(
            string suffix,
            CancellationToken cancellationToken = default
        );

        /// <summary>
        /// Remove Specified Suffix Resources ...
        /// </summary>
        /// <param name="suffix"></param>
        /// <param name="connectionId"></param>
        /// <param name="cancellationToken"></param>
        /// <returns></returns>
        Task Remove(
            string suffix,
            string connectionId = null,
            CancellationToken cancellationToken = default
        );

        /// <summary>
        /// Remove Specified Resource ...
        /// </summary>
        /// <param name="resource"></param>
        /// <param name="language"></param>
        /// <param name="connectionId"></param>
        /// <param name="cancellationToken"></param>
        /// <returns></returns>
        Task Remove(
            string resource,
            string language,
            string connectionId = null,
            CancellationToken cancellationToken = default
        );
        #endregion
    }
}