Class FileApiClient

Namespace

Ascon.Polynom.Web.Api.Client.Services

Assembly

Ascon.Polynom.Web.Api.Client.dll

Контроллер для работы с файлами.

public class FileApiClient : IDisposable

Inheritance

object

FileApiClient

Implements

IDisposable

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

FileApiClient(HttpClient)

public FileApiClient(HttpClient httpClient)

Parameters

httpClient HttpClient

Methods

AddToDocument(IAddToDocumentRequest, CancellationToken)

Добавляет файл документу.

public Task AddToDocument(IAddToDocumentRequest request, CancellationToken cancellationToken = default)

Parameters

request IAddToDocumentRequest

Запрос добавления файла документу.

cancellationToken CancellationToken

Returns

Task

AddToTicket(IAddToTicketRequest, CancellationToken)

Добавляет файл заявке.

public Task AddToTicket(IAddToTicketRequest request, CancellationToken cancellationToken = default)

Parameters

request IAddToTicketRequest

Запрос добавления файла заявке.

cancellationToken CancellationToken

Returns

Task

Delete(IDeleteRequest, CancellationToken)

Удаляет файл по идентификатору.

public Task Delete(IDeleteRequest request, CancellationToken cancellationToken = default)

Parameters

request IDeleteRequest

Идентификатор файла.

cancellationToken CancellationToken

Returns

Task

Dispose()

public void Dispose()

Download(IDownloadFileRequest, CancellationToken)

Возвращает содержимое файла из временного хранилища по имени файла.

public Task<Stream> Download(IDownloadFileRequest request, CancellationToken cancellationToken = default)

Parameters

request IDownloadFileRequest

Параметры запроса загрузки файла.

cancellationToken CancellationToken

Returns

Task<Stream>

GetByDocument(IIdentifierRequest, CancellationToken)

Возвращает файлы, принадлежащие документу.

public Task<List<IFile>?> GetByDocument(IIdentifierRequest request, CancellationToken cancellationToken = default)

Parameters

request IIdentifierRequest

Идентификатор документа.

cancellationToken CancellationToken

Returns

Task<List<IFile>>

GetById(IGetByIdRequest, CancellationToken)

Возвращает элемент.

public Task<IFile?> GetById(IGetByIdRequest request, CancellationToken cancellationToken = default)

Parameters

request IGetByIdRequest

Идентификатор элемента.

cancellationToken CancellationToken

Returns

Task<IFile>

GetByTicket(IIdentifierRequest, CancellationToken)

Возвращает файлы, принадлежащие заявке.

public Task<List<IFile>?> GetByTicket(IIdentifierRequest request, CancellationToken cancellationToken = default)

Parameters

request IIdentifierRequest

Идентификатор заявки.

cancellationToken CancellationToken

Returns

Task<List<IFile>>

GetByUid(IGetByUidRequest, CancellationToken)

Возвращает файл по его идентификатору.

public Task<IFile?> GetByUid(IGetByUidRequest request, CancellationToken cancellationToken = default)

Parameters

request IGetByUidRequest

Запрос поиска объекта по Guid.

cancellationToken CancellationToken

Returns

Task<IFile>

GetNameById(IGetByIdRequest, CancellationToken)

Возвращает имя временного файла в хранилище для скачивания файла.

public Task<string?> GetNameById(IGetByIdRequest request, CancellationToken cancellationToken = default)

Parameters

request IGetByIdRequest

Идентификатор файла.

cancellationToken CancellationToken

Returns

Task<string>

Rename(IRenameFileRequest, CancellationToken)

Изменяет имя файла документа.

public Task Rename(IRenameFileRequest request, CancellationToken cancellationToken = default)

Parameters

request IRenameFileRequest

Запрос редактирования файла.

cancellationToken CancellationToken

Returns

Task

Replace(IReplaceRequest, CancellationToken)

Заменяет содержимое файла документа.

public Task Replace(IReplaceRequest request, CancellationToken cancellationToken = default)

Parameters

request IReplaceRequest

Запрос замены файла.

cancellationToken CancellationToken

Returns

Task

Upload(byte[], CancellationToken)

Загружает файл из массива байт в multipart/form-data.

public Task<string?> Upload(byte[] fileBytes, CancellationToken cancellationToken = default)

Parameters

fileBytes byte[]

cancellationToken CancellationToken

Returns

Task<string>

Upload(Stream, CancellationToken)

Загружает файл во временное хранилище.

public Task<string?> Upload(Stream fileStream, CancellationToken cancellationToken = default)

Parameters

fileStream Stream

cancellationToken CancellationToken

Returns

Task<string>

Кодовое имя файла в файлом хранилище.