extends XResourceProvider and it's Related Requirements ...
This commit is contained in:
@@ -0,0 +1,137 @@
|
||||
using System.Collections.Generic;
|
||||
using System.Threading;
|
||||
using System.Threading.Tasks;
|
||||
using Microsoft.AspNetCore.Mvc;
|
||||
using xModels.Dtos;
|
||||
using xStringService.Models.Dtos;
|
||||
|
||||
namespace xStringService.Interfaces
|
||||
{
|
||||
public interface IXBaseResourceProviderController
|
||||
{
|
||||
/// <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 all Exists Items ...
|
||||
/// </summary>
|
||||
/// <param name="resource">Specified Resource Title</param>
|
||||
/// <param name="cancellationToken"></param>
|
||||
/// <returns></returns>
|
||||
[HttpGet("LocalesResource")]
|
||||
Task<ActionResult<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>
|
||||
[HttpGet("{language}/Translation")]
|
||||
Task<ActionResult<string>> GetResourceTranslation(
|
||||
[FromRoute] 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>
|
||||
[HttpGet("{language}/Has")]
|
||||
Task<ActionResult<bool>> HasLocale(
|
||||
[FromRoute] string language,
|
||||
CancellationToken cancellationToken = default
|
||||
);
|
||||
|
||||
/// <summary>
|
||||
/// Retrieve as Locale Model ...
|
||||
/// </summary>
|
||||
/// <param name="language">Specified Language ...</param>
|
||||
/// <param name="cancellationToken"></param>
|
||||
/// <returns></returns>
|
||||
[HttpGet("{language}/Locale")]
|
||||
Task<ActionResult<XLocaleResourceDto>> GetLocale(
|
||||
[FromRoute] string language,
|
||||
CancellationToken cancellationToken = default
|
||||
);
|
||||
|
||||
/// <summary>
|
||||
/// Retrieve all Exists Locale Models ...
|
||||
/// </summary>
|
||||
/// <param name="cancellationToken"></param>
|
||||
/// <returns></returns>
|
||||
[HttpGet("Locales")]
|
||||
Task<ActionResult<IEnumerable<XLocaleResourceDto>>> GetLocales(
|
||||
CancellationToken cancellationToken = default
|
||||
);
|
||||
|
||||
/// <summary>
|
||||
/// Retrieve as XResourceDto ...
|
||||
/// </summary>
|
||||
/// <param name="cancellationToken"></param>
|
||||
/// <returns></returns>
|
||||
[HttpGet("Resource")]
|
||||
Task<ActionResult<XResourceDto>> GetResource(
|
||||
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("")]
|
||||
Task<ActionResult<XResourceDto>> AddOrUpdateResource(
|
||||
[FromBody] XResourceDto resource,
|
||||
CancellationToken cancellationToken = default
|
||||
);
|
||||
|
||||
/// <summary>
|
||||
/// Add Or Update Locale ...
|
||||
/// </summary>
|
||||
/// <param name="locale"></param>
|
||||
/// <param name="cancellationToken"></param>
|
||||
/// <returns></returns>
|
||||
[HttpPost("Locales")]
|
||||
Task<ActionResult<XResourceDto>> AddOrUpdateLocale(
|
||||
[FromBody] XLocaleResourceDto locale,
|
||||
CancellationToken cancellationToken = default
|
||||
);
|
||||
|
||||
/// <summary>
|
||||
/// Remove Locale ...
|
||||
/// </summary>
|
||||
/// <param name="locale"></param>
|
||||
/// <param name="cancellationToken"></param>
|
||||
/// <returns></returns>
|
||||
[HttpPost("Locale/Remove")]
|
||||
Task<ActionResult<XResourceDto>> RemoveLocale(
|
||||
[FromBody] XLocaleResourceDto locale,
|
||||
CancellationToken cancellationToken = default
|
||||
);
|
||||
|
||||
/// <summary>
|
||||
/// Remove Specified Resource Model ...
|
||||
/// </summary>
|
||||
/// <param name="resource">a XResourceDto Model ...</param>
|
||||
/// <param name="cancellationToken"></param>
|
||||
/// <returns></returns>
|
||||
[HttpPost("Resource/Remove")]
|
||||
Task<ActionResult> RemoveResource(
|
||||
[FromBody] XResourceDto resource,
|
||||
CancellationToken cancellationToken = default
|
||||
);
|
||||
}
|
||||
}
|
||||
@@ -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
|
||||
);
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,127 @@
|
||||
using System.Collections.Generic;
|
||||
using System.Threading;
|
||||
using System.Threading.Tasks;
|
||||
using xIdentityModels.Models;
|
||||
using xModels.Dtos;
|
||||
using xPushService.Interfaces;
|
||||
using xStringService.Models.Dtos;
|
||||
using xStringService.Models.Entities;
|
||||
using xStringService.Providers.Dtos;
|
||||
|
||||
namespace xStringService.Interfaces
|
||||
{
|
||||
public interface IXStringProvider : IXBaseProvided<XString, XStringDto, int, XStringDtoHub>
|
||||
{
|
||||
//
|
||||
#region Tools ...
|
||||
/// <summary>
|
||||
/// Retrieve a List of Exists Languages ...
|
||||
/// </summary>
|
||||
/// <param name="cancellationToken"></param>
|
||||
/// <returns></returns>
|
||||
Task<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>
|
||||
Task<IEnumerable<string>> GetResourceTitles(
|
||||
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>
|
||||
Task<IEnumerable<XStringDto>> GetResourceLocales(
|
||||
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>
|
||||
Task<string> GetResourceTranslation(
|
||||
string language,
|
||||
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>
|
||||
Task<XLocaleResourceDto> GetLocale(
|
||||
string language,
|
||||
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>
|
||||
Task<IEnumerable<XLocaleResourceDto>> GetLocales(
|
||||
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>
|
||||
Task<XResourceDto> GetResource(
|
||||
string resource,
|
||||
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>
|
||||
/// 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
|
||||
);
|
||||
#endregion
|
||||
}
|
||||
}
|
||||
@@ -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
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user