Interface IContextItemStore

Interface for a store of context items.

Namespace: DataWeb.Structure

Assembly: DataWeb.Core.dll

Syntax

public interface IContextItemStore

Properties

Name

The name of the store.

Declaration

string Name { get; }

Property Value

Type	Description
string

Methods

GetContextItemAsync(ContextItemFilter, CancellationToken)

Retrieves a context item based on the provided filter.

Declaration

Task<ContextItemData> GetContextItemAsync(ContextItemFilter filter, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ContextItemFilter	filter	The ContextItemFilter used to retrieve the context item.
CancellationToken	cancellationToken

Returns

Type	Description
Task<ContextItemData>	A context item.

GetContextItemCountAsync(ContextItemFilter, CancellationToken)

Retrieves the number of context items based on the provided filter.

Declaration

Task<long> GetContextItemCountAsync(ContextItemFilter filter, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ContextItemFilter	filter	The ContextItemFilter used to retrieve the count of context items.
CancellationToken	cancellationToken

Returns

Type	Description
Task<long>	The number of context items that match the provided filter.

GetContextItemsAsync(ContextItemFilter, CancellationToken)

Retrieves a collection of context items based on the provided filter.

Declaration

Task<IEnumerable<ContextItemData>> GetContextItemsAsync(ContextItemFilter filter, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ContextItemFilter	filter	The ContextItemFilter used to retrieve the context items.
CancellationToken	cancellationToken

Returns

Type	Description
Task<IEnumerable<ContextItemData>>	A collection of context items.