Interface ISelectionPoolsClient

The client to execute selection pools operations in Content-Hub.

Namespace: StylelabsStylelabs.MSdkClients

Assembly: Stylelabs.M.Sdk.dll

Syntax

public interface ISelectionPoolsClient

Methods

ClearAsync(string, string, long?)

Clears a selection pool for an entity definition in Content-Hub. If the entity doesn't exist, nothing will happen.

Declaration

Task ClearAsync(string selectionPoolIdentifier, string definitionName, long? subPoolId = null)

Parameters

Type	Name	Description
string	selectionPoolIdentifier	The identifier of the selection pool.
string	definitionName	The name of the definition.
long	subPoolId	The id of the sub pool.

Returns

Type	Description
Task	A representing the asynchronous operation.

Exceptions

Type	Condition
ForbiddenException	Thrown when the entity exists but could not be deleted.

CreateAsync(string, string, IDictionary<string, IList>)

Creates a selection pool.

Declaration

Task<long> CreateAsync(string name, string identifier = null, IDictionary<string, IList<long>> items = null)

Parameters

Type	Name	Description
string	name	The name of the selection pool.
string	identifier	The identifier of the selection pool.
IDictionary<, >stringIList<>long	items	The collection of items to add to the selection pool.

Returns

Type	Description
Task<>long	A representing the asynchronous operation.

GetAsync(string, IEnumerable, long?, DateTimeOffset?, bool?)

Gets a selection pool.

Declaration

Task<ISelectionPool> GetAsync(string selectionPoolIdentifier, IEnumerable<string> definitionNames, long? subPoolId = null, DateTimeOffset? modifiedSince = null, bool? ignorePermissions = false)

Parameters

Type	Name	Description
string	selectionPoolIdentifier	The identifier of the selection pool.
IEnumerable<>string	definitionNames	The name of the definitions.
long	subPoolId	The id of the sub pool.
DateTimeOffset	modifiedSince	The last date the selection was modified.
bool	ignorePermissions	Whether to ignore permissions.

Returns

Type	Description
Task<>ISelectionPool	A ISelectionPool.

PatchAsync(PatchSelectionPoolRequest)

Patches a selection pool.

Declaration

Task PatchAsync(PatchSelectionPoolRequest request)

Parameters

Type	Name	Description
PatchSelectionPoolRequest	request	The PatchSelectionPoolRequest.

Returns

Type	Description
Task	A representing the asynchronous operation.

If you have suggestions for improving this article, let us know!