Class ViewpointGroupApiClient

Namespace

Ascon.Polynom.Web.Api.Client.Services

Assembly

Ascon.Polynom.Web.Api.Client.dll

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

public class ViewpointGroupApiClient : IDisposable

Inheritance

object

ViewpointGroupApiClient

Implements

IDisposable

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ViewpointGroupApiClient(HttpClient)

public ViewpointGroupApiClient(HttpClient httpClient)

Parameters

httpClient HttpClient

Methods

Create(ICreateViewpointGroupRequest, CancellationToken)

Создаёт новую группу представлений.

public Task<IViewpointGroup?> Create(ICreateViewpointGroupRequest request, CancellationToken cancellationToken = default)

Parameters

request ICreateViewpointGroupRequest

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

cancellationToken CancellationToken

Returns

Task<IViewpointGroup>

Delete(IDeleteRequest, CancellationToken)

Удаляет группу представлений.

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

Parameters

request IDeleteRequest

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

cancellationToken CancellationToken

Returns

Task

Dispose()

public void Dispose()

GetByCatalog(IGetByIdRequest, CancellationToken)

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

public Task<List<IViewpointGroup>?> GetByCatalog(IGetByIdRequest request, CancellationToken cancellationToken = default)

Parameters

request IGetByIdRequest

Идентификатор каталога представлений.

cancellationToken CancellationToken

Returns

Task<List<IViewpointGroup>>

GetByGroup(IGetByIdRequest, CancellationToken)

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

public Task<List<IViewpointGroup>?> GetByGroup(IGetByIdRequest request, CancellationToken cancellationToken = default)

Parameters

request IGetByIdRequest

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

cancellationToken CancellationToken

Returns

Task<List<IViewpointGroup>>

GetById(IGetByIdRequest, CancellationToken)

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

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

Parameters

request IGetByIdRequest

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

cancellationToken CancellationToken

Returns

Task<IViewpointGroup>

GetByLocation(string, CancellationToken)

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

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

Parameters

location string

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

cancellationToken CancellationToken

Returns

Task<IViewpointGroup>

GetByUid(IGetByUidRequest, CancellationToken)

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

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

Parameters

request IGetByUidRequest

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

cancellationToken CancellationToken

Returns

Task<IViewpointGroup>

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(IUpdateViewpointGroupRequest, CancellationToken)

Изменяет данные о группе представлений.

public Task<IViewpointGroup?> Update(IUpdateViewpointGroupRequest request, CancellationToken cancellationToken = default)

Parameters

request IUpdateViewpointGroupRequest

Группа представлений.

cancellationToken CancellationToken

Returns

Task<IViewpointGroup>