Interface IElementStore

Provides access to element data in the application.

Namespace: DataWeb.Structure

Assembly: DataWeb.Core.dll

Syntax

public interface IElementStore

Properties

Name

The name of the element store.

Declaration

string Name { get; }

Property Value

Type	Description
string

Methods

GetElementAsync(ElementFilter, CancellationToken)

Asynchronously retrieves the element that matches the specified filter.

Declaration

Task<ElementData> GetElementAsync(ElementFilter filter, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ElementFilter	filter	The filter used to retrieve the element.
CancellationToken	cancellationToken

Returns

Type	Description
Task<ElementData>	The element that matches the filter.

GetElementCachedAsync(string, CancellationToken)

Asynchronously retrieves the element with the specified name from cache.

Declaration

Task<ElementData> GetElementCachedAsync(string name, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	name	The name of the element.
CancellationToken	cancellationToken

Returns

Type	Description
Task<ElementData>	The element with the specified name.

GetElementsAsync(ElementFilter, CancellationToken)

Asynchronously retrieves elements that match the specified filter.

Declaration

Task<IEnumerable<ElementData>> GetElementsAsync(ElementFilter filter, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
ElementFilter	filter	The filter used to retrieve elements.
CancellationToken	cancellationToken

Returns

Type	Description
Task<IEnumerable<ElementData>>	An enumerable of elements that match the filter.