using AsbCloudApp.Data;
using System.IO;
using System.Threading;
using System.Threading.Tasks;

namespace AsbCloudApp.Services;

/// <summary>
/// Интерфейс сервиса справок страниц
/// </summary>
public interface IHelpPageService
{
    /// <summary>
    /// Создание справки
    /// </summary>
    /// <param name="urlPage"></param>
    /// <param name="idCategory"></param>
    /// <param name="fileName"></param>
    /// <param name="fileStream"></param>
    /// <param name="cancellationToken"></param>
    /// <returns></returns>
    Task<int> CreateAsync(string urlPage, 
        int idCategory,
        string fileName,
        Stream fileStream, 
        CancellationToken cancellationToken);

    /// <summary>
    /// Редактирование справки
    /// </summary>
    /// <param name="idCategory"></param>
    /// <param name="helpPage"></param>
    /// <param name="fileName"></param>
    /// <param name="fileStream"></param>
    /// <param name="cancellationToken"></param>
    /// <returns></returns>
    Task UpdateAsync(HelpPageDto helpPage,
        int idCategory,
        string fileName,
        Stream fileStream,
        CancellationToken cancellationToken);

    /// <summary>
    /// Получение справки по url страницы и id категории
    /// </summary>
    /// <param name="urlPage"></param>
    /// <param name="idCategory"></param>
    /// <param name="cancellationToken"></param>
    /// <returns></returns>
    Task<HelpPageDto?> GetOrDefaultByUrlPageAndIdCategoryAsync(string urlPage,
        int idCategory,
        CancellationToken cancellationToken);

    /// <summary>
    /// Получение справки по Id
    /// </summary>
    /// <param name="id"></param>
    /// <param name="cancellationToken"></param>
    /// <returns></returns>
    Task<HelpPageDto?> GetOrDefaultByIdAsync(int id,
        CancellationToken cancellationToken);

    /// <summary>
    /// Получение файла справки по Id
    /// </summary>
    /// <param name="helpPage"></param>
    /// <param name="cancellationToken"></param>
    /// <returns></returns>
    Stream GetFileStream(HelpPageDto helpPage);
}