Class ViewpointApiClient

Namespace

Ascon.Polynom.Web.Api.Client.Services

Assembly

Ascon.Polynom.Web.Api.Client.dll

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

public class ViewpointApiClient : IDisposable

Inheritance

object

ViewpointApiClient

Implements

IDisposable

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ViewpointApiClient(HttpClient)

public ViewpointApiClient(HttpClient httpClient)

Parameters

httpClient HttpClient

Methods

Create(ICreateViewpointRequest, CancellationToken)

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

public Task<IViewpoint?> Create(ICreateViewpointRequest request, CancellationToken cancellationToken = default)

Parameters

request ICreateViewpointRequest

Запрос создания представления.

cancellationToken CancellationToken

Returns

Task<IViewpoint>

CreateWithValues(ICreateViewpointWithValuesRequest, CancellationToken)

Создаёт новое представление с параметрами.

public Task<IViewpoint?> CreateWithValues(ICreateViewpointWithValuesRequest request, CancellationToken cancellationToken = default)

Parameters

request ICreateViewpointWithValuesRequest

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

cancellationToken CancellationToken

Returns

Task<IViewpoint>

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()

GetByElement(IGetByIdRequest, CancellationToken)

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

public Task<List<IViewpoint>?> GetByElement(IGetByIdRequest request, CancellationToken cancellationToken = default)

Parameters

request IGetByIdRequest

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

cancellationToken CancellationToken

Returns

Task<List<IViewpoint>>

GetByGroup(IIdentifierRequest, CancellationToken)

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

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

Parameters

request IIdentifierRequest

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

cancellationToken CancellationToken

Returns

Task<List<IViewpoint>>

GetById(IGetByIdRequest, CancellationToken)

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

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

Parameters

request IGetByIdRequest

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

cancellationToken CancellationToken

Returns

Task<IViewpoint>

GetByLocation(string, CancellationToken)

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

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

Parameters

location string

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

cancellationToken CancellationToken

Returns

Task<Viewpoint>

GetByUid(IGetByUidRequest, CancellationToken)

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

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

Parameters

request IGetByUidRequest

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

cancellationToken CancellationToken

Returns

Task<IViewpoint>

GetDefaultLocation(IGetDefaultLocation, CancellationToken)

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

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

Parameters

request IGetDefaultLocation

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

cancellationToken CancellationToken

Returns

Task<string>

GetKkLocation(IIdentifierRequest, CancellationToken)

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

public Task<string?> GetKkLocation(IIdentifierRequest request, CancellationToken cancellationToken = default)

Parameters

request IIdentifierRequest

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

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>>

LinkViewpointsToElement(ILinkViewpointsToElementRequest, CancellationToken)

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

public Task<List<IViewpoint>?> LinkViewpointsToElement(ILinkViewpointsToElementRequest request, CancellationToken cancellationToken = default)

Parameters

request ILinkViewpointsToElementRequest

Запрос привязки представлений.

cancellationToken CancellationToken

Returns

Task<List<IViewpoint>>

UnlinkViewpointsFromElement(IUnlinkViewpointsFromElementRequest, CancellationToken)

Отвязывает представление от элемента.

public Task<List<IViewpoint>?> UnlinkViewpointsFromElement(IUnlinkViewpointsFromElementRequest request, CancellationToken cancellationToken = default)

Parameters

request IUnlinkViewpointsFromElementRequest

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

cancellationToken CancellationToken

Returns

Task<List<IViewpoint>>

Update(IUpdateViewpointRequest, CancellationToken)

Обновляет представление.

public Task<IViewpoint?> Update(IUpdateViewpointRequest request, CancellationToken cancellationToken = default)

Parameters

request IUpdateViewpointRequest

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

cancellationToken CancellationToken

Returns

Task<IViewpoint>

UpdateSerialNumbers(IUpdateSerialNumbersRequest, CancellationToken)

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

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

Parameters

request IUpdateSerialNumbersRequest

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

cancellationToken CancellationToken

Returns

Task