Class ElementCatalogApiClient

Namespace

Ascon.Polynom.Web.Api.Client.Services

Assembly

Ascon.Polynom.Web.Api.Client.dll

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

public class ElementCatalogApiClient : IDisposable

Inheritance

object

ElementCatalogApiClient

Implements

IDisposable

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ElementCatalogApiClient(HttpClient)

public ElementCatalogApiClient(HttpClient httpClient)

Parameters

httpClient HttpClient

Methods

Create(ICreateElementCatalogRequest, CancellationToken)

Создаёт новый каталог элементов.

public Task<IElementCatalog?> Create(ICreateElementCatalogRequest request, CancellationToken cancellationToken = default)

Parameters

request ICreateElementCatalogRequest

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

cancellationToken CancellationToken

Returns

Task<IElementCatalog>

Delete(IDeleteRequest, CancellationToken)

Удаляет каталог элементов.

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

Parameters

request IDeleteRequest

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

cancellationToken CancellationToken

Returns

Task

Dispose()

public void Dispose()

GetById(IGetByIdRequest, CancellationToken)

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

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

Parameters

request IGetByIdRequest

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

cancellationToken CancellationToken

Returns

Task<IElementCatalog>

GetByLocation(string, CancellationToken)

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

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

Parameters

location string

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

cancellationToken CancellationToken

Returns

Task<IElementCatalog>

GetByReference(IIdentifierRequest, CancellationToken)

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

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

Parameters

request IIdentifierRequest

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

cancellationToken CancellationToken

Returns

Task<List<IElementCatalog>>

GetByUid(IGetByUidRequest, CancellationToken)

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

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

Parameters

request IGetByUidRequest

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

cancellationToken CancellationToken

Returns

Task<IElementCatalog>

GetDefaultLocation(IGetDefaultLocation, CancellationToken)

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

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

Parameters

request IGetDefaultLocation

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

cancellationToken CancellationToken

Returns

Task<string>

Update(IUpdateElementCatalogRequest, CancellationToken)

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

public Task<IElementCatalog?> Update(IUpdateElementCatalogRequest request, CancellationToken cancellationToken = default)

Parameters

request IUpdateElementCatalogRequest

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

cancellationToken CancellationToken

Returns

Task<IElementCatalog>