Class PropertyDefinitionApiClient

Namespace

Ascon.Polynom.Web.Api.Client.Services

Assembly

Ascon.Polynom.Web.Api.Client.dll

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

public class PropertyDefinitionApiClient : IDisposable

Inheritance

object

PropertyDefinitionApiClient

Implements

IDisposable

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PropertyDefinitionApiClient(HttpClient)

public PropertyDefinitionApiClient(HttpClient httpClient)

Parameters

httpClient HttpClient

Methods

AddColumn(IAddColumnRequest, CancellationToken)

Добавляет новый столбец в табличное определение свойства.

public Task AddColumn(IAddColumnRequest request, CancellationToken cancellationToken = default)

Parameters

request IAddColumnRequest

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

cancellationToken CancellationToken

Returns

Task

AddItem(IAddItemRequest, CancellationToken)

Добавляет новый пункт перечисления в определение свойства с типом "Перечислимое" или "Множество".

public Task AddItem(IAddItemRequest request, CancellationToken cancellationToken = default)

Parameters

request IAddItemRequest

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

cancellationToken CancellationToken

Returns

Task

Create(ICreatePropertyDefinitionRequest, CancellationToken)

Создает новое описание свойства.

public Task<IPropertyDefinition?> Create(ICreatePropertyDefinitionRequest request, CancellationToken cancellationToken = default)

Parameters

request ICreatePropertyDefinitionRequest

Запрос создания нового описания свойства.

cancellationToken CancellationToken

Returns

Task<IPropertyDefinition>

Delete(IDeleteRequest, CancellationToken)

Удаление определение свойства.

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

Parameters

request IDeleteRequest

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

cancellationToken CancellationToken

Returns

Task

Dispose()

public void Dispose()

GetByAbsoluteCode(IGetByAbsoluteCodeRequest, CancellationToken)

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

public Task<IPropertyDefinition?> GetByAbsoluteCode(IGetByAbsoluteCodeRequest request, CancellationToken cancellationToken = default)

Parameters

request IGetByAbsoluteCodeRequest

Полный код объекта.

cancellationToken CancellationToken

Returns

Task<IPropertyDefinition>

GetByCode(IGetByCodeRequest, CancellationToken)

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

public Task<IPropertyDefinitionWithItems?> GetByCode(IGetByCodeRequest request, CancellationToken cancellationToken = default)

Parameters

request IGetByCodeRequest

Код объекта.

cancellationToken CancellationToken

Returns

Task<IPropertyDefinitionWithItems>

GetByGroup(IIdentifierRequest, CancellationToken)

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

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

Parameters

request IIdentifierRequest

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

cancellationToken CancellationToken

Returns

Task<List<IPropertyDefinition>>

GetById(IGetByIdRequest, CancellationToken)

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

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

Parameters

request IGetByIdRequest

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

cancellationToken CancellationToken

Returns

Task<IPropertyDefinitionWithItems>

GetByName(IGetByNameRequest, CancellationToken)

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

public Task<IPropertyDefinitionWithItems?> GetByName(IGetByNameRequest request, CancellationToken cancellationToken = default)

Parameters

request IGetByNameRequest

Полное или частичное наименование объекта.

cancellationToken CancellationToken

Returns

Task<IPropertyDefinitionWithItems>

GetByUid(IGetByUidRequest, CancellationToken)

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

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

Parameters

request IGetByUidRequest

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

cancellationToken CancellationToken

Returns

Task<IPropertyDefinitionWithItems>

GetMoveToGroup(IGetMoveToGroupPropertyDefinitionGroupRequest, CancellationToken)

Возвращает признак того, может ли группа или объект быть перемещен в требуемую группу.

public Task<bool?> GetMoveToGroup(IGetMoveToGroupPropertyDefinitionGroupRequest request, CancellationToken cancellationToken = default)

Parameters

request IGetMoveToGroupPropertyDefinitionGroupRequest

Запрос проверки возможности перемещения.

cancellationToken CancellationToken

Returns

Task<bool?>

GetUsage(IIdentifierRequest, CancellationToken)

Возвращает информацию об использовании определения свойства.

public Task<IPropertyDefinitionUsage?> GetUsage(IIdentifierRequest request, CancellationToken cancellationToken = default)

Parameters

request IIdentifierRequest

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

cancellationToken CancellationToken

Returns

Task<IPropertyDefinitionUsage>

RemoveColumn(IRemoveColumnRequest, CancellationToken)

Удаляет столбец из табличного определения свойства.

public Task RemoveColumn(IRemoveColumnRequest request, CancellationToken cancellationToken = default)

Parameters

request IRemoveColumnRequest

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

cancellationToken CancellationToken

Returns

Task

RemoveItem(IRemoveItemRequest, CancellationToken)

Удаляет пункт перечисления из определения свойства с типом "Перечислимое" или "Множество".

public Task RemoveItem(IRemoveItemRequest request, CancellationToken cancellationToken = default)

Parameters

request IRemoveItemRequest

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

cancellationToken CancellationToken

Returns

Task

SetMoveToGroup(ISetMoveToGroupPropertyDefinitionGroupRequest, CancellationToken)

Перемещает объект или группу в требуемую группу.

public Task SetMoveToGroup(ISetMoveToGroupPropertyDefinitionGroupRequest request, CancellationToken cancellationToken = default)

Parameters

request ISetMoveToGroupPropertyDefinitionGroupRequest

Запрос перемещения.

cancellationToken CancellationToken

Returns

Task

Update(IUpdatePropertyDefinitionRequest, CancellationToken)

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

public Task<IPropertyDefinition?> Update(IUpdatePropertyDefinitionRequest request, CancellationToken cancellationToken = default)

Parameters

request IUpdatePropertyDefinitionRequest

Запрос создания нового описания свойства.

cancellationToken CancellationToken

Returns

Task<IPropertyDefinition>

UpdateColumn(IUpdateColumnRequest, CancellationToken)

Редактирует столбец в табличном определении свойства.

public Task UpdateColumn(IUpdateColumnRequest request, CancellationToken cancellationToken = default)

Parameters

request IUpdateColumnRequest

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

cancellationToken CancellationToken

Returns

Task