Class WebPageItemCacheDependencyBuilderExtensions

Namespace

CMS.Websites

Assembly

CMS.Websites.dll

Provides extension methods for the WebPageItemCacheDependencyBuilder class.

public static class WebPageItemCacheDependencyBuilderExtensions

Inheritance

object

WebPageItemCacheDependencyBuilderExtensions

Methods

ByCodeName(WebPageItemCacheDependencyBuilder, IWebPageFieldsSource, string)

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

public static WebPageItemCacheDependencyBuilder ByCodeName(this WebPageItemCacheDependencyBuilder webPageItemCacheDependencyBuilder, IWebPageFieldsSource webPageItem, string languageName = null)

Parameters

webPageItemCacheDependencyBuilder WebPageItemCacheDependencyBuilder

Web page item cache dependency builder.

webPageItem IWebPageFieldsSource

Web page item whose code name will be used.

languageName string

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

Returns

WebPageItemCacheDependencyBuilder

The WebPageItemCacheDependencyBuilder instance for method chaining.

ByCodeName(WebPageItemCacheDependencyBuilder, IEnumerable<IWebPageFieldsSource>, string)

Adds a dependency on web page items with the given code names.

public static WebPageItemCacheDependencyBuilder ByCodeName(this WebPageItemCacheDependencyBuilder webPageItemCacheDependencyBuilder, IEnumerable<IWebPageFieldsSource> webPageItems, string languageName = null)

Parameters

webPageItemCacheDependencyBuilder WebPageItemCacheDependencyBuilder

Web page item cache dependency builder.

webPageItems IEnumerable<IWebPageFieldsSource>

Collection of web page items whose code names will be used.

languageName string

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

Returns

WebPageItemCacheDependencyBuilder

The WebPageItemCacheDependencyBuilder instance for method chaining.

ByCodeName(WebPageItemCacheDependencyBuilder, IEnumerable<string>, string)

Adds a dependency on web page items with the given code names.

public static WebPageItemCacheDependencyBuilder ByCodeName(this WebPageItemCacheDependencyBuilder webPageItemCacheDependencyBuilder, IEnumerable<string> codeNames, string languageName = null)

Parameters

webPageItemCacheDependencyBuilder WebPageItemCacheDependencyBuilder

Web page item cache dependency builder.

codeNames IEnumerable<string>

Collection of web page item code names.

languageName string

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

Returns

WebPageItemCacheDependencyBuilder

The WebPageItemCacheDependencyBuilder instance for method chaining.

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

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

public static WebPageItemCacheDependencyBuilder ByContentType(this WebPageItemCacheDependencyBuilder webPageItemCacheDependencyBuilder, IEnumerable<string> contentTypeNames, string channelName, string languageName = null)

Parameters

webPageItemCacheDependencyBuilder WebPageItemCacheDependencyBuilder

Web page item cache dependency builder.

contentTypeNames IEnumerable<string>

Collection of web page item content type names.

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.

ByContentType(WebPageItemCacheDependencyBuilder, string, string, string)

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

public static WebPageItemCacheDependencyBuilder ByContentType(this WebPageItemCacheDependencyBuilder webPageItemCacheDependencyBuilder, string contentTypeName, string channelName, string languageName = null)

Parameters

webPageItemCacheDependencyBuilder WebPageItemCacheDependencyBuilder

Web page item cache dependency builder.

contentTypeName string

Content type name.

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.

ByGuid(WebPageItemCacheDependencyBuilder, IWebPageFieldsSource, string)

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

public static WebPageItemCacheDependencyBuilder ByGuid(this WebPageItemCacheDependencyBuilder webPageItemCacheDependencyBuilder, IWebPageFieldsSource webPageItem, string languageName = null)

Parameters

webPageItemCacheDependencyBuilder WebPageItemCacheDependencyBuilder

Web page item cache dependency builder.

webPageItem IWebPageFieldsSource

Web page item whose GUID will be used.

languageName string

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

Returns

WebPageItemCacheDependencyBuilder

The WebPageItemCacheDependencyBuilder instance for method chaining.

ByGuid(WebPageItemCacheDependencyBuilder, IEnumerable<IWebPageFieldsSource>, string)

Adds a dependency on web page items with the given GUIDs.

public static WebPageItemCacheDependencyBuilder ByGuid(this WebPageItemCacheDependencyBuilder webPageItemCacheDependencyBuilder, IEnumerable<IWebPageFieldsSource> webPageItems, string languageName = null)

Parameters

webPageItemCacheDependencyBuilder WebPageItemCacheDependencyBuilder

Web page item cache dependency builder.

webPageItems IEnumerable<IWebPageFieldsSource>

Collection of web page items whose GUIDs will be used.

languageName string

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

Returns

WebPageItemCacheDependencyBuilder

The WebPageItemCacheDependencyBuilder instance for method chaining.

ByGuid(WebPageItemCacheDependencyBuilder, IEnumerable<Guid>, string)

Adds a dependency on web page items with the given GUIDs.

public static WebPageItemCacheDependencyBuilder ByGuid(this WebPageItemCacheDependencyBuilder webPageItemCacheDependencyBuilder, IEnumerable<Guid> guids, string languageName = null)

Parameters

webPageItemCacheDependencyBuilder WebPageItemCacheDependencyBuilder

Web page item cache dependency builder.

guids IEnumerable<Guid>

Collection of web page item GUIDs.

languageName string

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

Returns

WebPageItemCacheDependencyBuilder

The WebPageItemCacheDependencyBuilder instance for method chaining.

ById(WebPageItemCacheDependencyBuilder, IWebPageFieldsSource, string)

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

public static WebPageItemCacheDependencyBuilder ById(this WebPageItemCacheDependencyBuilder webPageItemCacheDependencyBuilder, IWebPageFieldsSource webPageItem, string languageName = null)

Parameters

webPageItemCacheDependencyBuilder WebPageItemCacheDependencyBuilder

Web page item cache dependency builder.

webPageItem IWebPageFieldsSource

Web page item whose ID will be used.

languageName string

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

Returns

WebPageItemCacheDependencyBuilder

The WebPageItemCacheDependencyBuilder instance for method chaining.

ById(WebPageItemCacheDependencyBuilder, IEnumerable<IWebPageFieldsSource>, string)

Adds a dependency on web page items with the given IDs.

public static WebPageItemCacheDependencyBuilder ById(this WebPageItemCacheDependencyBuilder webPageItemCacheDependencyBuilder, IEnumerable<IWebPageFieldsSource> webPageItems, string languageName = null)

Parameters

webPageItemCacheDependencyBuilder WebPageItemCacheDependencyBuilder

Web page item cache dependency builder.

webPageItems IEnumerable<IWebPageFieldsSource>

Collection of web page items whose IDs will be used.

languageName string

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

Returns

WebPageItemCacheDependencyBuilder

The WebPageItemCacheDependencyBuilder instance for method chaining.

ById(WebPageItemCacheDependencyBuilder, IEnumerable<int>, string)

Adds a dependency on web page items with the given IDs.

public static WebPageItemCacheDependencyBuilder ById(this WebPageItemCacheDependencyBuilder webPageItemCacheDependencyBuilder, IEnumerable<int> ids, string languageName = null)

Parameters

webPageItemCacheDependencyBuilder WebPageItemCacheDependencyBuilder

Web page item cache dependency builder.

ids IEnumerable<int>

Collection of web page item IDs.

languageName string

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

Returns

WebPageItemCacheDependencyBuilder

The WebPageItemCacheDependencyBuilder instance for method chaining.

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

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

public static WebPageItemCacheDependencyBuilder ByPath(this WebPageItemCacheDependencyBuilder webPageItemCacheDependencyBuilder, IEnumerable<CacheDependencyPath> paths, string channelName, string languageName = null)

Parameters

webPageItemCacheDependencyBuilder WebPageItemCacheDependencyBuilder

Web page item cache dependency builder.

paths IEnumerable<CacheDependencyPath>

Web page tree paths 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.

ByReusableFieldSchema(WebPageItemCacheDependencyBuilder, IEnumerable<string>, string, string)

Adds a dependency on web page items with the given reusable field schemas assigned.

public static WebPageItemCacheDependencyBuilder ByReusableFieldSchema(this WebPageItemCacheDependencyBuilder webPageItemCacheDependencyBuilder, IEnumerable<string> reusableFieldSchemaNames, string channelName, string languageName = null)

Parameters

webPageItemCacheDependencyBuilder WebPageItemCacheDependencyBuilder

Web page item cache dependency builder.

reusableFieldSchemaNames IEnumerable<string>

Collection of reusable field schema names.

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.