Class DocumentCatalogApiClient

Namespace

Ascon.Polynom.Web.Api.Client.Services

Assembly

Ascon.Polynom.Web.Api.Client.dll

Контроллер для работы с каталогами документов.

public class DocumentCatalogApiClient : IDisposable

Inheritance

object

DocumentCatalogApiClient

Implements

IDisposable

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

DocumentCatalogApiClient(HttpClient)

public DocumentCatalogApiClient(HttpClient httpClient)

Parameters

httpClient HttpClient

Methods

Dispose()

public void Dispose()

GetById(IGetByIdRequest, CancellationToken)

Возвращает каталог документов.

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

Parameters

request IGetByIdRequest

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

cancellationToken CancellationToken

Returns

Task<IDocumentCatalog>

GetByLocation(string, CancellationToken)

Возвращает каталог документов.

public Task<IDocumentCatalog?> GetByLocation(string location, CancellationToken cancellationToken = default)

Parameters

location string

Строка расположения.

cancellationToken CancellationToken

Returns

Task<IDocumentCatalog>

GetByReference(IIdentifierRequest, CancellationToken)

Возвращает каталог документов справочника.

public Task<IDocumentCatalog?> GetByReference(IIdentifierRequest request, CancellationToken cancellationToken = default)

Parameters

request IIdentifierRequest

Идентификатор справочника.

cancellationToken CancellationToken

Returns

Task<IDocumentCatalog>

GetByUid(IGetByUidRequest, CancellationToken)

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

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

Parameters

request IGetByUidRequest

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

cancellationToken CancellationToken

Returns

Task<IDocumentCatalog>

GetDefaultLocation(IGetDefaultLocation, CancellationToken)

Возвращает строку расположения каталога документов.

public Task<string?> GetDefaultLocation(IGetDefaultLocation request, CancellationToken cancellationToken = default)

Parameters

request IGetDefaultLocation

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

cancellationToken CancellationToken

Returns

Task<string>

Update(IUpdateDocumentCatalogRequest, CancellationToken)

Изменяет данные о каталоге документов.

public Task<IDocumentCatalog?> Update(IUpdateDocumentCatalogRequest request, CancellationToken cancellationToken = default)

Parameters

request IUpdateDocumentCatalogRequest

Каталог документов.

cancellationToken CancellationToken

Returns

Task<IDocumentCatalog>