Class ElementGroupApiClient

Namespace

Ascon.Polynom.Web.Api.Client.Services

Assembly

Ascon.Polynom.Web.Api.Client.dll

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

public class ElementGroupApiClient : IDisposable

Inheritance

object

ElementGroupApiClient

Implements

IDisposable

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ElementGroupApiClient(HttpClient)

public ElementGroupApiClient(HttpClient httpClient)

Parameters

httpClient HttpClient

Methods

Create(ICreateElementGroupRequest, CancellationToken)

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

public Task<IElementGroup?> Create(ICreateElementGroupRequest request, CancellationToken cancellationToken = default)

Parameters

request ICreateElementGroupRequest

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

cancellationToken CancellationToken

Returns

Task<IElementGroup>

Delete(IDeleteRequest, CancellationToken)

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

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

Parameters

request IDeleteRequest

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

cancellationToken CancellationToken

Returns

Task

Dispose()

public void Dispose()

GetByCatalog(IIdentifierRequest, CancellationToken)

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

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

Parameters

request IIdentifierRequest

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

cancellationToken CancellationToken

Returns

Task<List<IElementGroup>>

GetByGroup(IIdentifierRequest, CancellationToken)

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

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

Parameters

request IIdentifierRequest

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

cancellationToken CancellationToken

Returns

Task<List<IElementGroup>>

GetById(IGetByIdRequest, CancellationToken)

Возвращает группу элементов

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

Parameters

request IGetByIdRequest

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

cancellationToken CancellationToken

Returns

Task<IElementGroup>

GetByLocation(string, CancellationToken)

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

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

Parameters

location string

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

cancellationToken CancellationToken

Returns

Task<IElementGroup>

GetByUid(IGetByUidRequest, CancellationToken)

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

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

Parameters

request IGetByUidRequest

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

cancellationToken CancellationToken

Returns

Task<IElementGroup>

GetDefaultLocation(IGetDefaultLocation, CancellationToken)

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

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

Parameters

request IGetDefaultLocation

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

cancellationToken CancellationToken

Returns

Task<string>

GetStatistics(IIdentifierRequest, CancellationToken)

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

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

Parameters

request IIdentifierRequest

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

cancellationToken CancellationToken

Returns

Task<IGroupStatistics>

Update(IUpdateElementGroupRequest, CancellationToken)

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

public Task<IElementGroup?> Update(IUpdateElementGroupRequest request, CancellationToken cancellationToken = default)

Parameters

request IUpdateElementGroupRequest

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

cancellationToken CancellationToken

Returns

Task<IElementGroup>