Interface IListStore

Defines the interface for a list data store.

Namespace: DataWeb.Data

Assembly: DataWeb.Core.dll

Syntax

public interface IListStore

Properties

Name

Gets the name of the list data store.

Declaration

string Name { get; }

Property Value

Type	Description
string

Methods

GetListAsync(ListFilter, string, CancellationToken)

Retrieves a list from the store that matches the specified filter and culture.

Declaration

Task<ListData> GetListAsync(ListFilter filter, string culture, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListFilter	filter	The filter to apply to the list.
string	culture	The culture to use for localization. If null, the default system culture is used.
CancellationToken	cancellationToken

Returns

Type	Description
Task<ListData>	A task that represents the asynchronous operation. The task result contains the list that matches the filter.

GetListCachedAsync(string, string, CancellationToken)

Retrieves a list from the store that matches the specified name and culture, and caches it.

Declaration

Task<ListData> GetListCachedAsync(string name, string culture, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	name	The name of the list to retrieve.
string	culture	The culture to use for localization. If null, the default system culture is used.
CancellationToken	cancellationToken

Returns

Type	Description
Task<ListData>	A task that represents the asynchronous operation. The task result contains the cached list that matches the name and culture.

GetListsAsync(ListFilter, string, CancellationToken)

Retrieves a collection of lists from the store that match the specified filter and culture.

Declaration

Task<IEnumerable<ListData>> GetListsAsync(ListFilter filter, string culture, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ListFilter	filter	The filter to apply to the list collection.
string	culture	The culture to use for localization. If null, the default system culture is used.
CancellationToken	cancellationToken

Returns

Type	Description
Task<IEnumerable<ListData>>	A task that represents the asynchronous operation. The task result contains a collection of lists that match the filter.