Class RestrictedListApiClient

Namespace

Ascon.Polynom.Web.Api.Client.Services

Assembly

Ascon.Polynom.Web.Api.Client.dll

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

public class RestrictedListApiClient : IDisposable

Inheritance

object

RestrictedListApiClient

Implements

IDisposable

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

RestrictedListApiClient(HttpClient)

public RestrictedListApiClient(HttpClient httpClient)

Parameters

httpClient HttpClient

Methods

AddOwner(IAddOwnerRestrictedListRequest, CancellationToken)

Добавляет владельца ограничительного перечня.

public Task AddOwner(IAddOwnerRestrictedListRequest request, CancellationToken cancellationToken = default)

Parameters

request IAddOwnerRestrictedListRequest

Объект запроса добавления владельца.

cancellationToken CancellationToken

Returns

Task

Create(CancellationToken)

Создает новый ограничительный перечень.

public Task<IRestrictedList?> Create(CancellationToken cancellationToken = default)

Parameters

cancellationToken CancellationToken

Returns

Task<IRestrictedList>

Delete(IDeleteRequest, CancellationToken)

Удаляет ограничительный перечень.

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

Parameters

request IDeleteRequest

Идентификатор ограничительного перечня.

cancellationToken CancellationToken

Returns

Task

Dispose()

public void Dispose()

GetAll(IGetAllRestrictedListRequest, CancellationToken)

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

public Task<PaginatedList<IRestrictedList>?> GetAll(IGetAllRestrictedListRequest request, CancellationToken cancellationToken = default)

Parameters

request IGetAllRestrictedListRequest

Объект запроса ограничительных перечней.

cancellationToken CancellationToken

Returns

Task<PaginatedList<IRestrictedList>>

GetByCode(IGetByCodeRequest, CancellationToken)

Возвращает ограничительный перечень по коду объекта.

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

Parameters

request IGetByCodeRequest

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

cancellationToken CancellationToken

Returns

Task<IRestrictedList>

GetByGroupPropertyOwner(IIdentifierRequest, CancellationToken)

Возвращает коллекцию ограничительных перечней владельца свойств.

public Task<List<IRestrictedListGroupPropertyOwnerItem>?> GetByGroupPropertyOwner(IIdentifierRequest request, CancellationToken cancellationToken = default)

Parameters

request IIdentifierRequest

Объект владельца свойств.

cancellationToken CancellationToken

Returns

Task<List<IRestrictedListGroupPropertyOwnerItem>>

GetById(IGetByIdRequest, CancellationToken)

Возвращает ограничительный перечень по идентификатору объекта.

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

Parameters

request IGetByIdRequest

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

cancellationToken CancellationToken

Returns

Task<IRestrictedList>

GetByUser(IGetByUserRestrictedListRequest, CancellationToken)

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

public Task<PaginatedList<IRestrictedList>?> GetByUser(IGetByUserRestrictedListRequest request, CancellationToken cancellationToken = default)

Parameters

request IGetByUserRestrictedListRequest

Запрос списка ограничительных перечней.

cancellationToken CancellationToken

Returns

Task<PaginatedList<IRestrictedList>>

GetOwners(IIdentifierRequest, CancellationToken)

Возвращает коллекцию объектов и документов, входящих в ограничительный перечень.

public Task<List<IIdentifiableObject>?> GetOwners(IIdentifierRequest request, CancellationToken cancellationToken = default)

Parameters

request IIdentifierRequest

Идентификатор ограничительного перечня.

cancellationToken CancellationToken

Returns

Task<List<IIdentifiableObject>>

GetRoleItem(IGetRoleItemRestrictedListRequest, CancellationToken)

Возвращает роль ограничительного перечня.

public Task<IRestrictedListRole?> GetRoleItem(IGetRoleItemRestrictedListRequest request, CancellationToken cancellationToken = default)

Parameters

request IGetRoleItemRestrictedListRequest

Запрос роли ограничительного перечня.

cancellationToken CancellationToken

Returns

Task<IRestrictedListRole>

GetRoleItems(IIdentifierRequest, CancellationToken)

Возвращает список ролей ограничительного перечня.

public Task<List<IIdentifiableObject>?> GetRoleItems(IIdentifierRequest request, CancellationToken cancellationToken = default)

Parameters

request IIdentifierRequest

Идентификатор ограничительного перечня.

cancellationToken CancellationToken

Returns

Task<List<IIdentifiableObject>>

GetStatistics(IIdentifierRequest, CancellationToken)

Возвращает статистику.

public Task<List<IIdentifiableObject>?> GetStatistics(IIdentifierRequest request, CancellationToken cancellationToken = default)

Parameters

request IIdentifierRequest

Идентификатор ограничительного перечня.

cancellationToken CancellationToken

Returns

Task<List<IIdentifiableObject>>

RemoveOwner(IRemoveOwnerRestrictedListRequest, CancellationToken)

Удаляет владельца ограничительного перечня.

public Task RemoveOwner(IRemoveOwnerRestrictedListRequest request, CancellationToken cancellationToken = default)

Parameters

request IRemoveOwnerRestrictedListRequest

Объект запроса удаления владельца.

cancellationToken CancellationToken

Returns

Task

SetItem(ISetItemRestrictedListRequest, CancellationToken)

Переключает ограничительный перечень у владельца.

public Task<IRestrictedListGroupPropertyOwnerItem?> SetItem(ISetItemRestrictedListRequest request, CancellationToken cancellationToken = default)

Parameters

request ISetItemRestrictedListRequest

Объект запроса ограничения перечня.

cancellationToken CancellationToken

Returns

Task<IRestrictedListGroupPropertyOwnerItem>

Update(IUpdateRestrictedListRequest, CancellationToken)

Редактирует ограничительный перечень.

public Task<IRestrictedList?> Update(IUpdateRestrictedListRequest request, CancellationToken cancellationToken = default)

Parameters

request IUpdateRestrictedListRequest

Объект редактирования ограничительного перечня.

cancellationToken CancellationToken

Returns

Task<IRestrictedList>

UpdateRoleItem(IUpdateRoleRestrictedListRequest, CancellationToken)

Редактирует значение элемента ограничительного перечня.

public Task<IRestrictedListRole?> UpdateRoleItem(IUpdateRoleRestrictedListRequest request, CancellationToken cancellationToken = default)

Parameters

request IUpdateRoleRestrictedListRequest

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

cancellationToken CancellationToken

Returns

Task<IRestrictedListRole>