Class ReferenceApiClient

Namespace

Ascon.Polynom.Web.Api.Client.Services

Assembly

Ascon.Polynom.Web.Api.Client.dll

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

public class ReferenceApiClient : IDisposable

Inheritance

object

ReferenceApiClient

Implements

IDisposable

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

ReferenceApiClient(HttpClient)

public ReferenceApiClient(HttpClient httpClient)

Parameters

httpClient HttpClient

Methods

Create(ICreateReferenceRequest, CancellationToken)

Создаёт новый справочник.

public Task<IReference?> Create(ICreateReferenceRequest request, CancellationToken cancellationToken = default)

Parameters

request ICreateReferenceRequest

Наименование справочника.

cancellationToken CancellationToken

Returns

Task<IReference>

Delete(IDeleteRequest, CancellationToken)

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

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

Parameters

request IDeleteRequest

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

cancellationToken CancellationToken

Returns

Task

Dispose()

public void Dispose()

GetAll(CancellationToken)

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

public Task<List<IReference>?> GetAll(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task<List<IReference>>

GetById(IGetByIdRequest, CancellationToken)

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

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

Parameters

request IGetByIdRequest

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

cancellationToken CancellationToken

Returns

Task<IReference>

GetByLocation(string, CancellationToken)

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

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

Parameters

location string

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

cancellationToken CancellationToken

Returns

Task<IReference>

GetByUid(IGetByUidRequest, CancellationToken)

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

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

Parameters

request IGetByUidRequest

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

cancellationToken CancellationToken

Returns

Task<IReference>

GetDefaultLocation(IGetDefaultLocation, CancellationToken)

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

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

Parameters

request IGetDefaultLocation

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

cancellationToken CancellationToken

Returns

Task<string>

GetEntries(IIdentifierRequest, CancellationToken)

Возвращает каталоги и группы справочника с включенной опцией «Быстрый доступ».

public Task<List<IClassifiableObject>?> GetEntries(IIdentifierRequest request, CancellationToken cancellationToken = default)

Parameters

request IIdentifierRequest

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

cancellationToken CancellationToken

Returns

Task<List<IClassifiableObject>>

GetOwnerReference(IIdentifierRequest, CancellationToken)

Возвращает справочник-владелец для указанного объекта.

public Task<IReference?> GetOwnerReference(IIdentifierRequest request, CancellationToken cancellationToken = default)

Parameters

request IIdentifierRequest

cancellationToken CancellationToken

Returns

Task<IReference>

Update(IUpdateReferenceRequest, CancellationToken)

Изменяет данные о справочнике.

public Task<IReference?> Update(IUpdateReferenceRequest request, CancellationToken cancellationToken = default)

Parameters

request IUpdateReferenceRequest

Параметры запроса обновления справочника.

cancellationToken CancellationToken

Returns

Task<IReference>