Class DocumentGroupApiClient

Namespace

Ascon.Polynom.Web.Api.Client.Services

Assembly

Ascon.Polynom.Web.Api.Client.dll

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

public class DocumentGroupApiClient : IDisposable

Inheritance

object

DocumentGroupApiClient

Implements

IDisposable

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

DocumentGroupApiClient(HttpClient)

public DocumentGroupApiClient(HttpClient httpClient)

Parameters

httpClient HttpClient

Methods

Create(ICreateDocumentGroupRequest, CancellationToken)

Создаёт новую группу документов.

public Task<IDocumentGroup?> Create(ICreateDocumentGroupRequest request, CancellationToken cancellationToken = default)

Parameters

request ICreateDocumentGroupRequest

Параметры создания группы документов.

cancellationToken CancellationToken

Returns

Task<IDocumentGroup>

Delete(IDeleteRequest, CancellationToken)

Удаляет группу документов.

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

Parameters

request IDeleteRequest

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

cancellationToken CancellationToken

Returns

Task

Dispose()

public void Dispose()

GetAssortmentsDocumentsPath(CancellationToken)

Возвращает путь до группы документов на сортаменты.

public Task<List<INamedObject>?> GetAssortmentsDocumentsPath(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task<List<INamedObject>>

GetByCatalog(IIdentifierRequest, CancellationToken)

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

public Task<List<IDocumentGroup>?> GetByCatalog(IIdentifierRequest request, CancellationToken cancellationToken = default)

Parameters

request IIdentifierRequest

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

cancellationToken CancellationToken

Returns

Task<List<IDocumentGroup>>

GetByGroup(IIdentifierRequest, CancellationToken)

Возвращает группы, находящиеся внутри указанной группы документов.

public Task<List<IDocumentGroup>?> GetByGroup(IIdentifierRequest request, CancellationToken cancellationToken = default)

Parameters

request IIdentifierRequest

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

cancellationToken CancellationToken

Returns

Task<List<IDocumentGroup>>

GetById(IGetByIdRequest, CancellationToken)

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

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

Parameters

request IGetByIdRequest

Идентификатор группы документов

cancellationToken CancellationToken

Returns

Task<IDocumentGroup>

GetByLocation(string, CancellationToken)

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

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

Parameters

location string

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

cancellationToken CancellationToken

Returns

Task<IDocumentGroup>

GetByUid(IGetByUidRequest, CancellationToken)

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

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

Parameters

request IGetByUidRequest

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

cancellationToken CancellationToken

Returns

Task<IDocumentGroup>

GetDefaultLocation(IGetDefaultLocation, CancellationToken)

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

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

Parameters

request IGetDefaultLocation

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

cancellationToken CancellationToken

Returns

Task<string>

GetMaterialsAssortmentsDocumentsPath(CancellationToken)

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

public Task<List<INamedObject>?> GetMaterialsAssortmentsDocumentsPath(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task<List<INamedObject>>

GetMaterialsDocumentsPath(CancellationToken)

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

public Task<List<INamedObject>?> GetMaterialsDocumentsPath(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task<List<INamedObject>>

GetStatistics(IIdentifierRequest, CancellationToken)

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

public Task<IGroupStatistics?> GetStatistics(IIdentifierRequest request, CancellationToken cancellationToken = default)

Parameters

request IIdentifierRequest

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

cancellationToken CancellationToken

Returns

Task<IGroupStatistics>

Update(IUpdateDocumentGroupRequest, CancellationToken)

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

public Task<IDocumentGroup?> Update(IUpdateDocumentGroupRequest request, CancellationToken cancellationToken = default)

Parameters

request IUpdateDocumentGroupRequest

Группа документов.

cancellationToken CancellationToken

Returns

Task<IDocumentGroup>