Class WebPageItemCacheDependencyBuilder

Namespace

CMS.Websites

Assembly

CMS.Websites.dll

Represents a builder for cache dependencies of web page items. CacheDependencyBuilder IWebPageFieldsSource

public sealed class WebPageItemCacheDependencyBuilder

Inheritance

object

WebPageItemCacheDependencyBuilder

Extension Methods

DataExtensions.With<T>(T, Action<T>)

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

WebPageItemCacheDependencyBuilderExtensions.ByCodeName(WebPageItemCacheDependencyBuilder, IWebPageFieldsSource, string)

WebPageItemCacheDependencyBuilderExtensions.ByCodeName(WebPageItemCacheDependencyBuilder, IEnumerable<IWebPageFieldsSource>, string)

WebPageItemCacheDependencyBuilderExtensions.ByCodeName(WebPageItemCacheDependencyBuilder, IEnumerable<string>, string)

WebPageItemCacheDependencyBuilderExtensions.ByContentType(WebPageItemCacheDependencyBuilder, IEnumerable<string>, string, string)

WebPageItemCacheDependencyBuilderExtensions.ByContentType(WebPageItemCacheDependencyBuilder, string, string, string)

WebPageItemCacheDependencyBuilderExtensions.ByGuid(WebPageItemCacheDependencyBuilder, IWebPageFieldsSource, string)

WebPageItemCacheDependencyBuilderExtensions.ByGuid(WebPageItemCacheDependencyBuilder, IEnumerable<IWebPageFieldsSource>, string)

WebPageItemCacheDependencyBuilderExtensions.ByGuid(WebPageItemCacheDependencyBuilder, IEnumerable<Guid>, string)

WebPageItemCacheDependencyBuilderExtensions.ById(WebPageItemCacheDependencyBuilder, IWebPageFieldsSource, string)

WebPageItemCacheDependencyBuilderExtensions.ById(WebPageItemCacheDependencyBuilder, IEnumerable<IWebPageFieldsSource>, string)

WebPageItemCacheDependencyBuilderExtensions.ById(WebPageItemCacheDependencyBuilder, IEnumerable<int>, string)

WebPageItemCacheDependencyBuilderExtensions.ByPath(WebPageItemCacheDependencyBuilder, IEnumerable<CacheDependencyPath>, string, string)

Methods

All(string)

Adds a dependency on all web page items.

public WebPageItemCacheDependencyBuilder All(string channelName = null)

Parameters

channelName string

Name of the channel that limits web page items considered.

Returns

WebPageItemCacheDependencyBuilder

The WebPageItemCacheDependencyBuilder instance for method chaining.

Builder()

Returns the root CacheDependencyBuilder.

public CacheDependencyBuilder Builder()

Returns

CacheDependencyBuilder

ByCodeName(string, string)

Adds a dependency on web page item with the given code name.

public WebPageItemCacheDependencyBuilder ByCodeName(string codeName, string languageName = null)

Parameters

codeName string

The code name of the web page item.

languageName string

Name of the language. If not specified, all languages are considered.

Returns

WebPageItemCacheDependencyBuilder

The WebPageItemCacheDependencyBuilder instance for method chaining.

ByContentType<T>(string, string)

Adds a dependency on web page items with the given content type.

public WebPageItemCacheDependencyBuilder ByContentType<T>(string channelName, string languageName = null) where T : IWebPageFieldsSource

Parameters

channelName string

Name of the channel that limits web page items considered.

languageName string

Name of the language. If not specified, all languages are considered.

Returns

WebPageItemCacheDependencyBuilder

The WebPageItemCacheDependencyBuilder instance for method chaining.

Type Parameters

T

Model representing the content type.

ByGuid(Guid, string)

Adds a dependency on web page item with the given GUID.

public WebPageItemCacheDependencyBuilder ByGuid(Guid guid, string languageName = null)

Parameters

guid Guid

The GUID of the web page item.

languageName string

Name of the language. If not specified, all languages are considered.

Returns

WebPageItemCacheDependencyBuilder

The WebPageItemCacheDependencyBuilder instance for method chaining.

ById(int, string)

Adds a dependency on web page item with the given ID.

public WebPageItemCacheDependencyBuilder ById(int id, string languageName = null)

Parameters

id int

The ID of the web page item.

languageName string

Name of the language. If not specified, all languages are considered.

Returns

WebPageItemCacheDependencyBuilder

The WebPageItemCacheDependencyBuilder instance for method chaining.

ByPath(CacheDependencyPath, string, string)

Adds a dependency on web page items matching given tree path.

public WebPageItemCacheDependencyBuilder ByPath(CacheDependencyPath path, string channelName, string languageName = null)

Parameters

path CacheDependencyPath

Web page tree path for which the cache key should be limited.

channelName string

Name of the channel that limits web page items considered.

languageName string

Name of the language. If not specified, all languages are considered.

Returns

WebPageItemCacheDependencyBuilder

The WebPageItemCacheDependencyBuilder instance for method chaining.