Class ElementApiClient

Namespace

Ascon.Polynom.Web.Api.Client.Services

Assembly

Ascon.Polynom.Web.Api.Client.dll

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

public class ElementApiClient : IDisposable

Inheritance

object

ElementApiClient

Implements

IDisposable

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ElementApiClient(HttpClient)

public ElementApiClient(HttpClient httpClient)

Parameters

httpClient HttpClient

Methods

Create(ICreateElementRequest, CancellationToken)

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

public Task<IElement?> Create(ICreateElementRequest request, CancellationToken cancellationToken = default)

Parameters

request ICreateElementRequest

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

cancellationToken CancellationToken

Returns

Task<IElement>

CreateWithValues(ICreateElementWithValuesRequest, CancellationToken)

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

public Task<IElement?> CreateWithValues(ICreateElementWithValuesRequest request, CancellationToken cancellationToken = default)

Parameters

request ICreateElementWithValuesRequest

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

cancellationToken CancellationToken

Returns

Task<IElement>

Delete(IDeleteElementRequest, CancellationToken)

Удаляет элемент.

public Task<List<IIdentifiableObject>?> Delete(IDeleteElementRequest request, CancellationToken cancellationToken = default)

Parameters

request IDeleteElementRequest

Запрос удаления элемента.

cancellationToken CancellationToken

Returns

Task<List<IIdentifiableObject>>

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

DeleteMany(IDeleteManyElementsRequest, CancellationToken)

Удаляет элементы.

public Task<IDeleteManyElementsResponse?> DeleteMany(IDeleteManyElementsRequest request, CancellationToken cancellationToken = default)

Parameters

request IDeleteManyElementsRequest

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

cancellationToken CancellationToken

Returns

Task<IDeleteManyElementsResponse>

Dispose()

public void Dispose()

GetBoLocation(IIdentifierRequest, CancellationToken)

Возвращает строковый идентификатор для базового протокола (BOSimple).

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

Parameters

request IIdentifierRequest

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

cancellationToken CancellationToken

Returns

Task<string>

GetByDocument(IIdentifierRequest, CancellationToken)

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

public Task<List<IElement>?> GetByDocument(IIdentifierRequest request, CancellationToken cancellationToken = default)

Parameters

request IIdentifierRequest

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

cancellationToken CancellationToken

Returns

Task<List<IElement>>

GetByGroup(IIdentifierRequest, CancellationToken)

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

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

Parameters

request IIdentifierRequest

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

cancellationToken CancellationToken

Returns

Task<List<IElement>>

GetById(IGetByIdRequest, CancellationToken)

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

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

Parameters

request IGetByIdRequest

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

cancellationToken CancellationToken

Returns

Task<IElement>

GetByLocation(string, CancellationToken)

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

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

Parameters

location string

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

cancellationToken CancellationToken

Returns

Task<IElement>

GetByUid(IGetByUidRequest, CancellationToken)

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

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

Parameters

request IGetByUidRequest

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

cancellationToken CancellationToken

Returns

Task<IElement>

GetByViewpoint(IIdentifierRequest, CancellationToken)

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

public Task<List<IElement>?> GetByViewpoint(IIdentifierRequest request, CancellationToken cancellationToken = default)

Parameters

request IIdentifierRequest

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

cancellationToken CancellationToken

Returns

Task<List<IElement>>

GetDefaultLocation(IGetDefaultLocation, CancellationToken)

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

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

Parameters

request IGetDefaultLocation

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

cancellationToken CancellationToken

Returns

Task<string>

GetExtraLocations(IIdentifierRequest, CancellationToken)

Возвращает строки дополнительных расположений элемента.

public Task<IGetExtraLocationsResponse?> GetExtraLocations(IIdentifierRequest request, CancellationToken cancellationToken = default)

Parameters

request IIdentifierRequest

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

cancellationToken CancellationToken

Returns

Task<IGetExtraLocationsResponse>

GetKkLocation(IIdentifierRequest, CancellationToken)

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

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

Parameters

request IIdentifierRequest

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

cancellationToken CancellationToken

Returns

Task<string>

GetLinkDefEndForSortMat(IIdentifierRequest, CancellationToken)

Возвращает конец определения связи для материала/сортамента.

public Task<ILinkDefinitionEnd?> GetLinkDefEndForSortMat(IIdentifierRequest request, CancellationToken cancellationToken = default)

Parameters

request IIdentifierRequest

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

cancellationToken CancellationToken

Returns

Task<ILinkDefinitionEnd>

GetLinkedElementsLocations(IGetLinkedElementsLocationsRequest, CancellationToken)

Возвращает список расположений связанных элементов выбранной связи элемента-источника.

public Task<List<string>?> GetLinkedElementsLocations(IGetLinkedElementsLocationsRequest request, CancellationToken cancellationToken = default)

Parameters

request IGetLinkedElementsLocationsRequest

Запрос списка расположений.

cancellationToken CancellationToken

Returns

Task<List<string>>

GetSerialNumbers(IIdentifierRequest, CancellationToken)

Возвращает порядковые номера объекта.

public Task<ISerialNumbersResponse?> GetSerialNumbers(IIdentifierRequest request, CancellationToken cancellationToken = default)

Parameters

request IIdentifierRequest

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

cancellationToken CancellationToken

Returns

Task<ISerialNumbersResponse>

GetTemplate(IGetTemplateRequest, CancellationToken)

Возвращает шаблон для заполнения свойств элемента.

public Task<IPropertyOwnerContainer?> GetTemplate(IGetTemplateRequest request, CancellationToken cancellationToken = default)

Parameters

request IGetTemplateRequest

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

cancellationToken CancellationToken

Returns

Task<IPropertyOwnerContainer>

LinkElementsToViewpoint(ILinkElementsToViewpointRequest, CancellationToken)

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

public Task<List<IElement>?> LinkElementsToViewpoint(ILinkElementsToViewpointRequest request, CancellationToken cancellationToken = default)

Parameters

request ILinkElementsToViewpointRequest

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

cancellationToken CancellationToken

Returns

Task<List<IElement>>

UnlinkElementsFromViewpoint(IUnlinkElementsFromViewpointRequest, CancellationToken)

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

public Task<List<IElement>?> UnlinkElementsFromViewpoint(IUnlinkElementsFromViewpointRequest request, CancellationToken cancellationToken = default)

Parameters

request IUnlinkElementsFromViewpointRequest

Запрос открепления элемента.

cancellationToken CancellationToken

Returns

Task<List<IElement>>

Update(IUpdateElementRequest, CancellationToken)

Редактирует элемент.

public Task<IDocument?> Update(IUpdateElementRequest request, CancellationToken cancellationToken = default)

Parameters

request IUpdateElementRequest

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

cancellationToken CancellationToken

Returns

Task<IDocument>

UpdateExtraLocations(IUpdateExtraLocationsRequest, CancellationToken)

Редактирует список дополнительных идентификаторов элемента.

public Task UpdateExtraLocations(IUpdateExtraLocationsRequest request, CancellationToken cancellationToken = default)

Parameters

request IUpdateExtraLocationsRequest

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

cancellationToken CancellationToken

Returns

Task

UpdateSerialNumbers(IUpdateSerialNumbersRequest, CancellationToken)

Редактирует внутренний уникальный номер объекта.

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

Parameters

request IUpdateSerialNumbersRequest

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

cancellationToken CancellationToken

Returns

Task