1. ISelectionPoolsClient

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
TypeNameDescription
stringselectionPoolIdentifier

The identifier of the selection pool.

stringdefinitionName

The name of the definition.

longsubPoolId

The id of the sub pool.

Returns
TypeDescription
Task

A representing the asynchronous operation.

Exceptions
TypeCondition
ForbiddenException

Thrown when the entity exists but could not be deleted.

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

Creates a selection pool.

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

The name of the selection pool.

stringidentifier

The identifier of the selection pool.

IDictionary<, >stringIList<>longitems

The collection of items to add to the selection pool.

Returns
TypeDescription
Task<>long

A representing the asynchronous operation.

GetAsync(string, IEnumerable<string>, 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
TypeNameDescription
stringselectionPoolIdentifier

The identifier of the selection pool.

IEnumerable<>stringdefinitionNames

The name of the definitions.

longsubPoolId

The id of the sub pool.

DateTimeOffsetmodifiedSince

The last date the selection was modified.

boolignorePermissions

Whether to ignore permissions.

Returns
TypeDescription
Task<>ISelectionPool

A ISelectionPool.

PatchAsync(PatchSelectionPoolRequest)

Patches a selection pool.

Declaration
Task PatchAsync(PatchSelectionPoolRequest request)
Parameters
TypeNameDescription
PatchSelectionPoolRequestrequest

The PatchSelectionPoolRequest.

Returns
TypeDescription
Task

A representing the asynchronous operation.

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