Interface IAppTemplateStore

The interface for a template store implementation, which provides CRUD operations for templates.

Namespace: DataWeb.Templating

Assembly: DataWeb.Core.dll

Syntax

public interface IAppTemplateStore

Properties

Name

Gets the name of the template store.

Declaration

string Name { get; }

Property Value

Type	Description
string

Methods

GetAppTemplateAsync(AppTemplateFilter, string, CancellationToken)

Gets a template that matches the specified filter.

Declaration

Task<AppTemplate> GetAppTemplateAsync(AppTemplateFilter filter, string culture = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
AppTemplateFilter	filter	The AppTemplateFilter to apply.
string	culture	The culture for version filtering.
CancellationToken	cancellationToken

Returns

Type	Description
Task<AppTemplate>	The template that matches the specified filter.

GetAppTemplateCachedAsync(string, string, CancellationToken)

Gets a template that matches the specified filter.

Declaration

Task<AppTemplate> GetAppTemplateCachedAsync(string name, string culture = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	name	The name of the template.
string	culture	The culture for version filtering.
CancellationToken	cancellationToken

Returns

Type	Description
Task<AppTemplate>	The template that matches the specified name.

GetAppTemplateContextsAsync(string, CancellationToken)

Gets the contexts for all templates.

Declaration

Task<IEnumerable<string>> GetAppTemplateContextsAsync(string culture = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	culture	The culture for version filtering.
CancellationToken	cancellationToken

Returns

Type	Description
Task<IEnumerable<string>>	An enumerable collection of context strings.

GetAppTemplateContextsCachedAsync(string, CancellationToken)

Gets the contexts for all templates.

Declaration

Task<IEnumerable<string>> GetAppTemplateContextsCachedAsync(string culture = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	culture	The culture for version filtering.
CancellationToken	cancellationToken

Returns

Type	Description
Task<IEnumerable<string>>	An enumerable collection of context strings.

GetAppTemplateCountAsync(AppTemplateFilter, string, CancellationToken)

Gets the count of templates that match the specified filter.

Declaration

Task<long> GetAppTemplateCountAsync(AppTemplateFilter filter, string culture = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
AppTemplateFilter	filter	The AppTemplateFilter to apply.
string	culture	The culture for version filtering.
CancellationToken	cancellationToken

Returns

Type	Description
Task<long>	The count of templates that match the specified filter.

GetAppTemplatesAsync(AppTemplateFilter, string, CancellationToken)

Gets the templates that match the specified filter.

Declaration

Task<IEnumerable<AppTemplate>> GetAppTemplatesAsync(AppTemplateFilter filter, string culture = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
AppTemplateFilter	filter	The AppTemplateFilter to apply.
string	culture	The culture for version filtering.
CancellationToken	cancellationToken

Returns

Type	Description
Task<IEnumerable<AppTemplate>>	An enumerable collection of templates.

GetContextAppTemplatesCachedAsync(string, string, CancellationToken)

Retrieves all templates from cache.

Declaration

Task<IEnumerable<AppTemplate>> GetContextAppTemplatesCachedAsync(string templateContext, string culture = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	templateContext	The template context.
string	culture	The culture for version filtering.
CancellationToken	cancellationToken

Returns

Type	Description
Task<IEnumerable<AppTemplate>>	An IEnumerable<T> of Template objects.

GetImageAsync(AppTemplateFileFilter, string, CancellationToken)

Gets a template image that matches the specified filter.

Declaration

Task<FileData> GetImageAsync(AppTemplateFileFilter filter, string culture = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
AppTemplateFileFilter	filter	The AppTemplateFileFilter to apply.
string	culture	The culture for version filtering.
CancellationToken	cancellationToken

Returns

Type	Description
Task<FileData>	The image that matches the specified filter.

GetImageCachedAsync(string, string, CancellationToken)

Gets a template image that matches the specified filter.

Declaration

Task<FileData> GetImageCachedAsync(string code, string culture = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
string	code	The code of the image.
string	culture	The culture for version filtering.
CancellationToken	cancellationToken

Returns

Type	Description
Task<FileData>	The cached image that matches the specified code.

GetImagesAsync(AppTemplateFileFilter, string, CancellationToken)

Gets a template images that match the specified filter.

Declaration

Task<IEnumerable<FileData>> GetImagesAsync(AppTemplateFileFilter filter, string culture = null, CancellationToken cancellationToken = default)

Parameters

Type	Name	Description
AppTemplateFileFilter	filter	The AppTemplateFileFilter to apply.
string	culture	The culture for version filtering.
CancellationToken	cancellationToken

Returns

Type	Description
Task<IEnumerable<FileData>>	The images that match the specified filter.