Interface IObjectsRetriever

Namespace

Kentico.Xperience.Admin.Base.Forms

Assembly

Kentico.Xperience.Admin.Base.dll

Provides methods for providing objects.

public interface IObjectsRetriever

Extension Methods

DataExtensions.With<T>(T, Action<T>)

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Methods

GetObjectsAsync<T>(ObjectsRetrievalOptions<T>, CancellationToken)

Provides a collection of objects according the criteria given by retrievalParams.

Task<ObjectsRetrievalResult<T>> GetObjectsAsync<T>(ObjectsRetrievalOptions<T> retrievalParams, CancellationToken cancellationToken)

Parameters

retrievalParams ObjectsRetrievalOptions<T>

Options of an objects retrieval. See ObjectsRetrievalOptions<T>.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<ObjectsRetrievalResult<T>>

Type Parameters

T

Denotes a type of Value.

GetSelectedObjectsAsync<T>(SelectedObjectsRetrievalOptions<T>, CancellationToken)

Provides a collection of ObjectSelectorListItem<T>s which corresponds to the selected objects given by SelectedObjectsIdentifiers.

Task<IEnumerable<ObjectSelectorListItem<T>>> GetSelectedObjectsAsync<T>(SelectedObjectsRetrievalOptions<T> retrievalOptions, CancellationToken cancellationToken)

Parameters

retrievalOptions SelectedObjectsRetrievalOptions<T>

Retrieval options.

cancellationToken CancellationToken

Cancellation token.

Returns

Task<IEnumerable<ObjectSelectorListItem<T>>>

Type Parameters

T

Denotes a type of Value.