117 lines
4.3 KiB
C#
117 lines
4.3 KiB
C#
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 IXBaseItemResourceProviderController
|
|
{
|
|
/// <summary>
|
|
/// Retrieve a List of Exists Languages ...
|
|
/// </summary>
|
|
/// <param name="identifier">if null or empty, check all languages in Item Side</param>
|
|
/// <param name="cancellationToken"></param>
|
|
/// <returns></returns>
|
|
[HttpGet("Languages")]
|
|
Task<ActionResult<IEnumerable<string>>> GetLanguages(
|
|
[FromQuery] object identifier,
|
|
CancellationToken cancellationToken = default
|
|
);
|
|
|
|
/// <summary>
|
|
/// Retrieve all Exists Items ...
|
|
/// </summary>
|
|
/// <param name="resource">Specified Resource Title</param>
|
|
/// <param name="cancellationToken"></param>
|
|
/// <returns></returns>
|
|
[HttpGet("ResourceLocales")]
|
|
Task<ActionResult<IEnumerable<XStringDto>>> GetResourceLocales(
|
|
[FromQuery] object identifier,
|
|
CancellationToken cancellationToken = default
|
|
);
|
|
|
|
/// <summary>
|
|
/// Get all Exists Items for Specified identitifer ...
|
|
/// </summary>
|
|
/// <param name="identifier"></param>
|
|
/// <param name="cancellationToken"></param>
|
|
/// <returns></returns>
|
|
[HttpGet("Locales/{identifier}")]
|
|
Task<ActionResult<IEnumerable<XLocaleResourceDto>>> GetLocales(
|
|
[FromRoute] object identifier,
|
|
CancellationToken cancellationToken = default
|
|
);
|
|
|
|
/// <summary>
|
|
/// Remove Specified Language Locale of Specified Identifier ...
|
|
/// </summary>
|
|
/// <param name="identifier"></param>
|
|
/// <param name="language">if null or empty Remove all Locales</param>
|
|
/// <param name="cancellationToken"></param>
|
|
/// <returns></returns>
|
|
[HttpDelete("Locales/{identifier}")]
|
|
Task<ActionResult<XResourceDto>> RemoveLocale(
|
|
[FromRoute] object identifier,
|
|
[FromQuery] string language,
|
|
CancellationToken cancellationToken = default
|
|
);
|
|
|
|
/// <summary>
|
|
/// Check Specified ocale Exists for Specified Identifier ...
|
|
/// </summary>
|
|
/// <param name="identifier"></param>
|
|
/// <param name="language"></param>
|
|
/// <param name="cancellationToken"></param>
|
|
/// <returns></returns>
|
|
[HttpGet("Locales/{identifier}/{language}/Has")]
|
|
Task<ActionResult<bool>> HasLocale(
|
|
[FromRoute] object identifier,
|
|
[FromRoute] string language,
|
|
CancellationToken cancellationToken = default
|
|
);
|
|
|
|
/// <summary>
|
|
/// Get all Exists Locales Representaion based on Specified Identitifer
|
|
/// as XResourceDto ...
|
|
/// </summary>
|
|
/// <param name="identifier"></param>
|
|
/// <param name="cancellationToken"></param>
|
|
/// <returns></returns>
|
|
[HttpGet("Resource/{identifier}")]
|
|
Task<ActionResult<XResourceDto>> GetResource(
|
|
[FromRoute] object identifier,
|
|
CancellationToken cancellationToken = default
|
|
);
|
|
|
|
/// <summary>
|
|
/// Add Or Update Locale for Specified Identitifer ...
|
|
/// </summary>
|
|
/// <param name="identifier"></param>
|
|
/// <param name="locale"></param>
|
|
/// <param name="cancellationToken"></param>
|
|
/// <returns></returns>
|
|
[HttpPost("Locales/{identifier}")]
|
|
Task<ActionResult<XResourceDto>> AddOrUpdateLocale(
|
|
[FromRoute] object identifier,
|
|
[FromBody] XLocaleResourceDto locale,
|
|
CancellationToken cancellationToken = default
|
|
);
|
|
|
|
/// <summary>
|
|
/// Update a Resource State ...
|
|
/// </summary>
|
|
/// <param name="identifier"></param>
|
|
/// <param name="resource"></param>
|
|
/// <param name="cancellationToken"></param>
|
|
/// <returns></returns>
|
|
[HttpPost("Resource/{identifier}")]
|
|
Task<ActionResult<XResourceDto>> AddOrUpdateResource(
|
|
[FromRoute] object identifier,
|
|
[FromBody] XResourceDto resource,
|
|
CancellationToken cancellationToken = default
|
|
);
|
|
}
|
|
} |