Class FavoritesApiClient

Namespace

Ascon.Polynom.Web.Api.Client.Services

Assembly

Ascon.Polynom.Web.Api.Client.dll

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

public class FavoritesApiClient : IDisposable

Inheritance

object

FavoritesApiClient

Implements

IDisposable

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

FavoritesApiClient(HttpClient)

public FavoritesApiClient(HttpClient httpClient)

Parameters

httpClient HttpClient

Methods

Add(IAddToRequest, CancellationToken)

Добавляет объект в избранное.

public Task<IFavoritesItem?> Add(IAddToRequest request, CancellationToken cancellationToken = default)

Parameters

request IAddToRequest

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

cancellationToken CancellationToken

Returns

Task<IFavoritesItem>

AddMany(IAddManyToRequest, CancellationToken)

Добавляет объекты на панель избранного.

public Task<List<IFavoritesItem>?> AddMany(IAddManyToRequest request, CancellationToken cancellationToken = default)

Parameters

request IAddManyToRequest

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

cancellationToken CancellationToken

Returns

Task<List<IFavoritesItem>>

Dispose()

public void Dispose()

GetByCatalog(CancellationToken)

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

public Task<List<IFavoritesItem>?> GetByCatalog(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task<List<IFavoritesItem>>

GetByGroup(IIdentifierRequest, CancellationToken)

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

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

Parameters

request IIdentifierRequest

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

cancellationToken CancellationToken

Returns

Task<List<IFavoritesItem>>

GetById(IGetByIdRequest, CancellationToken)

Возвращает избранный элемент.

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

Parameters

request IGetByIdRequest

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

cancellationToken CancellationToken

Returns

Task<IClassifiableObject>

IsInFavorites(IIdentifierRequest, CancellationToken)

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

public Task<bool?> IsInFavorites(IIdentifierRequest request, CancellationToken cancellationToken = default)

Parameters

request IIdentifierRequest

Запрос проверки нахождения в избранном.

cancellationToken CancellationToken

Returns

Task<bool?>

MoveToGroup(IMoveToRequest, CancellationToken)

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

public Task MoveToGroup(IMoveToRequest request, CancellationToken cancellationToken = default)

Parameters

request IMoveToRequest

Запрос перемещения объекта.

cancellationToken CancellationToken

Returns

Task

Remove(IIdentifierRequest, CancellationToken)

Удаляет объект или группу из каталога избранного.

public Task Remove(IIdentifierRequest request, CancellationToken cancellationToken = default)

Parameters

request IIdentifierRequest

Идентификатор удаляемого объекта.

cancellationToken CancellationToken

Returns

Task

RemoveMany(IRemoveManyRequest, CancellationToken)

Удаляет элементы и группы из каталога избранного.

public Task RemoveMany(IRemoveManyRequest request, CancellationToken cancellationToken = default)

Parameters

request IRemoveManyRequest

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

cancellationToken CancellationToken

Returns

Task