Interface ISectionStore

Interface for accessing section data from a data store.

Namespace: DataWeb.Structure

Assembly: DataWeb.Core.dll

Syntax

public interface ISectionStore

Properties

Name

Gets the name of the store.

Declaration

string Name { get; }

Property Value

Type	Description
string

Methods

GetAreaSectionsCachedAsync(string, PublishMode, CancellationToken)

Gets a cached list of all sections belonging to a specific area.

Declaration

Task<IEnumerable<SectionData>> GetAreaSectionsCachedAsync(string areaIdMaster, PublishMode publishMode = PublishMode.Preview, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	areaIdMaster	The Id of the area to get sections for.
PublishMode	publishMode	The PublishMode to use.
CancellationToken	cancellationToken

Returns

Type	Description
Task<IEnumerable<SectionData>>	A cached list of all sections belonging to a specific area.

GetElementSectionsCachedAsync(string, PublishMode, CancellationToken)

Gets a cached list of all sections belonging to a specific element.

Declaration

Task<IEnumerable<SectionData>> GetElementSectionsCachedAsync(string elementIdMaster, PublishMode publishMode = PublishMode.Preview, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	elementIdMaster	The Id of the element to get sections for.
PublishMode	publishMode	The PublishMode to use.
CancellationToken	cancellationToken

Returns

Type	Description
Task<IEnumerable<SectionData>>	A cached list of all sections belonging to a specific element.

GetSectionAsync(SectionFilter, CancellationToken)

Gets a section based on a filter.

Declaration

Task<SectionData> GetSectionAsync(SectionFilter filter, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
SectionFilter	filter	The SectionFilter to apply.
CancellationToken	cancellationToken

Returns

Type	Description
Task<SectionData>	The section that matches the filter.

GetSectionCachedAsync(string, CancellationToken)

Gets a cached section by its name.

Declaration

Task<SectionData> GetSectionCachedAsync(string name, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	name	The name of the section to get.
CancellationToken	cancellationToken

Returns

Type	Description
Task<SectionData>	The cached section that matches the name.

GetSectionsAsync(SectionFilter, CancellationToken)

Gets a list of sections based on a filter.

Declaration

Task<IEnumerable<SectionData>> GetSectionsAsync(SectionFilter filter, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
SectionFilter	filter	The SectionFilter to apply.
CancellationToken	cancellationToken

Returns

Type	Description
Task<IEnumerable<SectionData>>	A list of sections.

GetSectionsCachedAsync(PublishMode, CancellationToken)

Gets a cached list of all sections.

Declaration

Task<IEnumerable<SectionData>> GetSectionsCachedAsync(PublishMode publishMode = PublishMode.Preview, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
PublishMode	publishMode	The PublishMode to use.
CancellationToken	cancellationToken

Returns

Type	Description
Task<IEnumerable<SectionData>>	A cached list of all sections.