Class DocumentApiClient

Namespace

Ascon.Polynom.Web.Api.Client.Services

Assembly

Ascon.Polynom.Web.Api.Client.dll

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

public class DocumentApiClient : IDisposable

Inheritance

object

DocumentApiClient

Implements

IDisposable

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

DocumentApiClient(HttpClient)

public DocumentApiClient(HttpClient httpClient)

Parameters

httpClient HttpClient

Methods

Create(ICreateDocumentRequest, CancellationToken)

Создаёт новый документ.

public Task<IDocument?> Create(ICreateDocumentRequest request, CancellationToken cancellationToken = default)

Parameters

request ICreateDocumentRequest

Запрос создания документа.

cancellationToken CancellationToken

Returns

Task<IDocument>

CreateWithValues(ICreateDocumentWithValuesRequest, CancellationToken)

Создаёт новый документ с параметрами.

public Task<IDocument?> CreateWithValues(ICreateDocumentWithValuesRequest request, CancellationToken cancellationToken = default)

Parameters

request ICreateDocumentWithValuesRequest

Запрос создания документа с параметрами.

cancellationToken CancellationToken

Returns

Task<IDocument>

Delete(IDeleteRequest, CancellationToken)

Удаляет документ.

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

Parameters

request IDeleteRequest

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

cancellationToken CancellationToken

Returns

Task

DeleteMany(IDeleteManyRequest, CancellationToken)

Удаляет список документов.

public Task<IDeleteManyResponse?> DeleteMany(IDeleteManyRequest request, CancellationToken cancellationToken = default)

Parameters

request IDeleteManyRequest

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

cancellationToken CancellationToken

Returns

Task<IDeleteManyResponse>

Dispose()

public void Dispose()

GetByDocumentGroup(IIdentifierRequest, CancellationToken)

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

public Task<List<IDocument>?> GetByDocumentGroup(IIdentifierRequest request, CancellationToken cancellationToken = default)

Parameters

request IIdentifierRequest

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

cancellationToken CancellationToken

Returns

Task<List<IDocument>>

GetByElement(IIdentifierRequest, CancellationToken)

Возвращает собственные документы элемента.

public Task<List<IDocument>?> GetByElement(IIdentifierRequest request, CancellationToken cancellationToken = default)

Parameters

request IIdentifierRequest

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

cancellationToken CancellationToken

Returns

Task<List<IDocument>>

GetByElementGroup(IIdentifierRequest, CancellationToken)

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

public Task<List<IDocument>?> GetByElementGroup(IIdentifierRequest request, CancellationToken cancellationToken = default)

Parameters

request IIdentifierRequest

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

cancellationToken CancellationToken

Returns

Task<List<IDocument>>

GetById(IGetByIdRequest, CancellationToken)

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

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

Parameters

request IGetByIdRequest

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

cancellationToken CancellationToken

Returns

Task<IDocument>

GetByLocation(string, CancellationToken)

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

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

Parameters

location string

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

cancellationToken CancellationToken

Returns

Task<IDocument>

GetByUid(IGetByUidRequest, CancellationToken)

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

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

Parameters

request IGetByUidRequest

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

cancellationToken CancellationToken

Returns

Task<IDocument>

GetDefaultLocation(IGetDefaultLocation, CancellationToken)

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

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

Parameters

request IGetDefaultLocation

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

cancellationToken CancellationToken

Returns

Task<string>

GetSerialNumbers(IIdentifierRequest, CancellationToken)

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

public Task<ISerialNumbersResponse?> GetSerialNumbers(IIdentifierRequest request, CancellationToken cancellationToken = default)

Parameters

request IIdentifierRequest

Идентификатор объекта.

cancellationToken CancellationToken

Returns

Task<ISerialNumbersResponse>

GetTemplate(IIdentifierRequest, CancellationToken)

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

public Task<IPropertyOwnerResponse?> GetTemplate(IIdentifierRequest request, CancellationToken cancellationToken = default)

Parameters

request IIdentifierRequest

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

cancellationToken CancellationToken

Returns

Task<IPropertyOwnerResponse>

GetUsages(IIdentifierRequest, CancellationToken)

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

public Task<List<IClassificationObject>?> GetUsages(IIdentifierRequest request, CancellationToken cancellationToken = default)

Parameters

request IIdentifierRequest

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

cancellationToken CancellationToken

Returns

Task<List<IClassificationObject>>

LinkDocumentOwners(ILinkDocumentOwnersRequest, CancellationToken)

Привязывает документ к владельцам.

public Task<List<IClassificationObject>?> LinkDocumentOwners(ILinkDocumentOwnersRequest request, CancellationToken cancellationToken = default)

Parameters

request ILinkDocumentOwnersRequest

Запрос привязки документа к владельцам.

cancellationToken CancellationToken

Returns

Task<List<IClassificationObject>>

UnlinkDocumentOwners(IUnlinkDocumentOwnersRequest, CancellationToken)

Отвязывает документ от владельцев.

public Task<List<IClassificationObject>?> UnlinkDocumentOwners(IUnlinkDocumentOwnersRequest request, CancellationToken cancellationToken = default)

Parameters

request IUnlinkDocumentOwnersRequest

Запрос отвязки документа от владельцев.

cancellationToken CancellationToken

Returns

Task<List<IClassificationObject>>

Update(IUpdateDocumentRequest, CancellationToken)

Обновляет документ.

public Task<IDocument?> Update(IUpdateDocumentRequest request, CancellationToken cancellationToken = default)

Parameters

request IUpdateDocumentRequest

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

cancellationToken CancellationToken

Returns

Task<IDocument>

UpdateSerialNumbers(IUpdateSerialNumbersRequest, CancellationToken)

Редактирует внутренний уникальный номер документа.

public Task UpdateSerialNumbers(IUpdateSerialNumbersRequest request, CancellationToken cancellationToken = default)

Parameters

request IUpdateSerialNumbersRequest

Параметры запроса.

cancellationToken CancellationToken

Returns

Task