Interface IAreaStore

Interface for a store of geographic areas.

Namespace: DataWeb.Structure

Assembly: DataWeb.Core.dll

Syntax

public interface IAreaStore

Properties

Name

The name of the area store.

Declaration

string Name { get; }

Property Value

Type	Description
string

Methods

GetAreaAsync(AreaFilter, CancellationToken)

Asynchronously retrieves a single area data that match the specified area filter.

Declaration

Task<AreaData> GetAreaAsync(AreaFilter filter, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
AreaFilter	filter	The filter used to select the area.
CancellationToken	cancellationToken

Returns

Type	Description
Task<AreaData>	A single area data that match the specified filter.

GetAreaCachedAsync(string, CancellationToken)

Asynchronously retrieves a single area data with the specified name from a cache.

Declaration

Task<AreaData> GetAreaCachedAsync(string name, CancellationToken cancellationToken = default)

Parameters

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

Returns

Type	Description
Task<AreaData>	A single area data with the specified name.

GetAreasAsync(AreaFilter, CancellationToken)

Asynchronously retrieves a collection of area data that match the specified area filter.

Declaration

Task<IEnumerable<AreaData>> GetAreasAsync(AreaFilter filter, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
AreaFilter	filter	The filter used to select the areas.
CancellationToken	cancellationToken

Returns

Type	Description
Task<IEnumerable<AreaData>>	A collection of area data that match the specified filter.

GetAreasCachedAsync(PublishMode, CancellationToken)

Asynchronously retrieves a collection of area data that match the specified area filter from a cache.

Declaration

Task<IEnumerable<AreaData>> GetAreasCachedAsync(PublishMode publishMode = PublishMode.Preview, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
PublishMode	publishMode	The mode used to retrieve data from the cache.
CancellationToken	cancellationToken

Returns

Type	Description
Task<IEnumerable<AreaData>>	A collection of area data that match the specified filter.