Class WebPageItemCacheDependencyBuilderExtensions

Namespace

Kentico.Content.Web.Mvc

Assembly

Kentico.Content.Web.Mvc.dll

Provides extension methods for the WebPageItemCacheDependencyBuilder class.

public static class WebPageItemCacheDependencyBuilderExtensions

Inheritance

object

WebPageItemCacheDependencyBuilderExtensions

Methods

AllWithChannelContext(WebPageItemCacheDependencyBuilder)

Adds a dependency on all web page items in the current channel from the website context.

public static WebPageItemCacheDependencyBuilder AllWithChannelContext(this WebPageItemCacheDependencyBuilder builder)

Parameters

builder WebPageItemCacheDependencyBuilder

Returns

WebPageItemCacheDependencyBuilder

The WebPageItemCacheDependencyBuilder instance for method chaining.

ByCodeNameWithLanguageContext(WebPageItemCacheDependencyBuilder, IWebPageFieldsSource)

Adds a dependency on a web page item with the given code name in the preferred language from the website context.

public static WebPageItemCacheDependencyBuilder ByCodeNameWithLanguageContext(this WebPageItemCacheDependencyBuilder builder, IWebPageFieldsSource webPageItem)

Parameters

builder WebPageItemCacheDependencyBuilder

Web page item cache dependency builder.

webPageItem IWebPageFieldsSource

Web page item whose code name will be used.

Returns

WebPageItemCacheDependencyBuilder

The WebPageItemCacheDependencyBuilder instance for method chaining.

ByCodeNameWithLanguageContext(WebPageItemCacheDependencyBuilder, IEnumerable<IWebPageFieldsSource>)

Adds dependencies on web page items with the given code names in the preferred language from the website context.

public static WebPageItemCacheDependencyBuilder ByCodeNameWithLanguageContext(this WebPageItemCacheDependencyBuilder builder, IEnumerable<IWebPageFieldsSource> webPageItems)

Parameters

builder WebPageItemCacheDependencyBuilder

Web page item cache dependency builder.

webPageItems IEnumerable<IWebPageFieldsSource>

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

Returns

WebPageItemCacheDependencyBuilder

The WebPageItemCacheDependencyBuilder instance for method chaining.

ByCodeNameWithLanguageContext(WebPageItemCacheDependencyBuilder, IEnumerable<string>)

Adds dependencies on web page items with the given code names in the preferred language from the website context.

public static WebPageItemCacheDependencyBuilder ByCodeNameWithLanguageContext(this WebPageItemCacheDependencyBuilder builder, IEnumerable<string> codeNames)

Parameters

builder WebPageItemCacheDependencyBuilder

Web page item cache dependency builder.

codeNames IEnumerable<string>

Collection of web page item code names.

Returns

WebPageItemCacheDependencyBuilder

The WebPageItemCacheDependencyBuilder instance for method chaining.

ByCodeNameWithLanguageContext(WebPageItemCacheDependencyBuilder, string)

Adds a dependency on a web page item with the given code name in the preferred language from the website context.

public static WebPageItemCacheDependencyBuilder ByCodeNameWithLanguageContext(this WebPageItemCacheDependencyBuilder builder, string codeName)

Parameters

builder WebPageItemCacheDependencyBuilder

Web page item cache dependency builder.

codeName string

Web page item code name.

Returns

WebPageItemCacheDependencyBuilder

The WebPageItemCacheDependencyBuilder instance for method chaining.

ByContentTypeWithChannelContext<T>(WebPageItemCacheDependencyBuilder, string)

Adds a dependency on web page items with the given type in the current channel from the website context.

public static WebPageItemCacheDependencyBuilder ByContentTypeWithChannelContext<T>(this WebPageItemCacheDependencyBuilder builder, string languageName = null) where T : IWebPageFieldsSource

Parameters

builder WebPageItemCacheDependencyBuilder

Web page item cache dependency builder.

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.

ByContentTypeWithContext<T>(WebPageItemCacheDependencyBuilder)

Adds a dependency on web page items with the given type in the current channel and preferred language from the website context.

public static WebPageItemCacheDependencyBuilder ByContentTypeWithContext<T>(this WebPageItemCacheDependencyBuilder builder) where T : IWebPageFieldsSource

Parameters

builder WebPageItemCacheDependencyBuilder

Web page item cache dependency builder.

Returns

WebPageItemCacheDependencyBuilder

The WebPageItemCacheDependencyBuilder instance for method chaining.

Type Parameters

T

Model representing the content type.

ByContentTypeWithLanguageContext<T>(WebPageItemCacheDependencyBuilder, string)

Adds a dependency on web page items with the given type in the preferred language from the website context.

public static WebPageItemCacheDependencyBuilder ByContentTypeWithLanguageContext<T>(this WebPageItemCacheDependencyBuilder builder, string channelName) where T : IWebPageFieldsSource

Parameters

builder WebPageItemCacheDependencyBuilder

Web page item cache dependency builder.

channelName string

Name of the channel that limits web page items considered.

Returns

WebPageItemCacheDependencyBuilder

The WebPageItemCacheDependencyBuilder instance for method chaining.

Type Parameters

T

Model representing the content type.

ByGuidWithLanguageContext(WebPageItemCacheDependencyBuilder, IWebPageFieldsSource)

Adds a dependency on web page item with the given GUID in the preferred language from the website context.

public static WebPageItemCacheDependencyBuilder ByGuidWithLanguageContext(this WebPageItemCacheDependencyBuilder builder, IWebPageFieldsSource webPageItem)

Parameters

builder WebPageItemCacheDependencyBuilder

Web page item cache dependency builder.

webPageItem IWebPageFieldsSource

Web page item whose GUID will be used.

Returns

WebPageItemCacheDependencyBuilder

The WebPageItemCacheDependencyBuilder instance for method chaining.

ByGuidWithLanguageContext(WebPageItemCacheDependencyBuilder, IEnumerable<IWebPageFieldsSource>)

Adds a dependency on web page items with the given GUIDs in the preferred language from the website context.

public static WebPageItemCacheDependencyBuilder ByGuidWithLanguageContext(this WebPageItemCacheDependencyBuilder builder, IEnumerable<IWebPageFieldsSource> webPageItems)

Parameters

builder WebPageItemCacheDependencyBuilder

Web page item cache dependency builder.

webPageItems IEnumerable<IWebPageFieldsSource>

Collection of web page items whose GUIDs will be used.

Returns

WebPageItemCacheDependencyBuilder

The WebPageItemCacheDependencyBuilder instance for method chaining.

ByGuidWithLanguageContext(WebPageItemCacheDependencyBuilder, IEnumerable<Guid>)

Adds dependencies on web page items with the given GUIDs in the preferred language from the website context.

public static WebPageItemCacheDependencyBuilder ByGuidWithLanguageContext(this WebPageItemCacheDependencyBuilder builder, IEnumerable<Guid> guids)

Parameters

builder WebPageItemCacheDependencyBuilder

Web page item cache dependency builder.

guids IEnumerable<Guid>

Collection of web page item GUIDs.

Returns

WebPageItemCacheDependencyBuilder

The WebPageItemCacheDependencyBuilder instance for method chaining.

ByGuidWithLanguageContext(WebPageItemCacheDependencyBuilder, Guid)

Adds a dependency on a web page item with the given GUID in the preferred language from the website context.

public static WebPageItemCacheDependencyBuilder ByGuidWithLanguageContext(this WebPageItemCacheDependencyBuilder builder, Guid guid)

Parameters

builder WebPageItemCacheDependencyBuilder

Web page item cache dependency builder.

guid Guid

Web page item GUID.

Returns

WebPageItemCacheDependencyBuilder

The WebPageItemCacheDependencyBuilder instance for method chaining.

ByIdWithLanguageContext(WebPageItemCacheDependencyBuilder, IWebPageFieldsSource)

Adds a dependency on web page item with the given ID in the preferred language from the website context.

public static WebPageItemCacheDependencyBuilder ByIdWithLanguageContext(this WebPageItemCacheDependencyBuilder builder, IWebPageFieldsSource webPageItem)

Parameters

builder WebPageItemCacheDependencyBuilder

Web page item cache dependency builder.

webPageItem IWebPageFieldsSource

Web page item whose ID will be used.

Returns

WebPageItemCacheDependencyBuilder

The WebPageItemCacheDependencyBuilder instance for method chaining.

Remarks

Language name is gathered from the website context.

ByIdWithLanguageContext(WebPageItemCacheDependencyBuilder, IEnumerable<IWebPageFieldsSource>)

Adds a dependency on web page items with the given IDs in the preferred language from the website context.

public static WebPageItemCacheDependencyBuilder ByIdWithLanguageContext(this WebPageItemCacheDependencyBuilder builder, IEnumerable<IWebPageFieldsSource> webPageItems)

Parameters

builder WebPageItemCacheDependencyBuilder

Web page item cache dependency builder.

webPageItems IEnumerable<IWebPageFieldsSource>

Collection of web page items whose IDs will be used.

Returns

WebPageItemCacheDependencyBuilder

The WebPageItemCacheDependencyBuilder instance for method chaining.

Remarks

Language name is gathered from the website context.

ByIdWithLanguageContext(WebPageItemCacheDependencyBuilder, IEnumerable<int>)

Adds a dependency on web page items with the given IDs in the preferred language from the website context.

public static WebPageItemCacheDependencyBuilder ByIdWithLanguageContext(this WebPageItemCacheDependencyBuilder builder, IEnumerable<int> ids)

Parameters

builder WebPageItemCacheDependencyBuilder

Web page item cache dependency builder.

ids IEnumerable<int>

Collection web page item IDs.

Returns

WebPageItemCacheDependencyBuilder

The WebPageItemCacheDependencyBuilder instance for method chaining.

Remarks

Language name is gathered from the website context.

ByIdWithLanguageContext(WebPageItemCacheDependencyBuilder, int)

Adds a dependency on web page item with the given ID in the preferred language from the website context.

public static WebPageItemCacheDependencyBuilder ByIdWithLanguageContext(this WebPageItemCacheDependencyBuilder builder, int id)

Parameters

builder WebPageItemCacheDependencyBuilder

Web page item cache dependency builder.

id int

The ID of the web page item.

Returns

WebPageItemCacheDependencyBuilder

The WebPageItemCacheDependencyBuilder instance for method chaining.

Remarks

Language name is gathered from the website context.

ByPathWithChannelContext(WebPageItemCacheDependencyBuilder, CacheDependencyPath, string)

Adds a dependency on web page items matching given tree path in the current channel from the website context.

public static WebPageItemCacheDependencyBuilder ByPathWithChannelContext(this WebPageItemCacheDependencyBuilder builder, CacheDependencyPath path, string languageName = null)

Parameters

builder WebPageItemCacheDependencyBuilder

Web page item cache dependency builder.

path CacheDependencyPath

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

languageName string

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

Returns

WebPageItemCacheDependencyBuilder

The WebPageItemCacheDependencyBuilder instance for method chaining.

ByPathWithChannelContext(WebPageItemCacheDependencyBuilder, IEnumerable<CacheDependencyPath>, string)

Adds a dependency on web page items matching given tree paths in the current channel from the website context.

public static WebPageItemCacheDependencyBuilder ByPathWithChannelContext(this WebPageItemCacheDependencyBuilder builder, IEnumerable<CacheDependencyPath> paths, string languageName = null)

Parameters

builder WebPageItemCacheDependencyBuilder

Web page item cache dependency builder.

paths IEnumerable<CacheDependencyPath>

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

languageName string

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

Returns

WebPageItemCacheDependencyBuilder

The WebPageItemCacheDependencyBuilder instance for method chaining.

ByPathWithContext(WebPageItemCacheDependencyBuilder, CacheDependencyPath)

Adds a dependency on web page items matching given tree path in the current channel and preferred language from the website context.

public static WebPageItemCacheDependencyBuilder ByPathWithContext(this WebPageItemCacheDependencyBuilder builder, CacheDependencyPath path)

Parameters

builder WebPageItemCacheDependencyBuilder

Web page item cache dependency builder.

path CacheDependencyPath

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

Returns

WebPageItemCacheDependencyBuilder

The WebPageItemCacheDependencyBuilder instance for method chaining.

ByPathWithContext(WebPageItemCacheDependencyBuilder, IEnumerable<CacheDependencyPath>)

Adds a dependency on web page items matching given tree paths in the current channel and preferred language from the website context.

public static WebPageItemCacheDependencyBuilder ByPathWithContext(this WebPageItemCacheDependencyBuilder builder, IEnumerable<CacheDependencyPath> paths)

Parameters

builder WebPageItemCacheDependencyBuilder

Web page item cache dependency builder.

paths IEnumerable<CacheDependencyPath>

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

Returns

WebPageItemCacheDependencyBuilder

The WebPageItemCacheDependencyBuilder instance for method chaining.

ByPathWithLanguageContext(WebPageItemCacheDependencyBuilder, CacheDependencyPath, string)

Adds a dependency on web page items matching given tree path in the preferred language from the website context.

public static WebPageItemCacheDependencyBuilder ByPathWithLanguageContext(this WebPageItemCacheDependencyBuilder builder, CacheDependencyPath path, string channelName)

Parameters

builder WebPageItemCacheDependencyBuilder

Web page item cache dependency builder.

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.

Returns

WebPageItemCacheDependencyBuilder

The WebPageItemCacheDependencyBuilder instance for method chaining.

ByPathWithLanguageContext(WebPageItemCacheDependencyBuilder, IEnumerable<CacheDependencyPath>, string)

Adds a dependency on web page items matching given tree paths in the preferred language from the website context.

public static WebPageItemCacheDependencyBuilder ByPathWithLanguageContext(this WebPageItemCacheDependencyBuilder builder, IEnumerable<CacheDependencyPath> paths, string channelName)

Parameters

builder 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.

Returns

WebPageItemCacheDependencyBuilder

The WebPageItemCacheDependencyBuilder instance for method chaining.

ByReusableFieldSchemaWithChannelContext(WebPageItemCacheDependencyBuilder, IEnumerable<string>, string)

Adds dependencies on web page items with the given reusable field schemas assigned in the current channel from the website context.

public static WebPageItemCacheDependencyBuilder ByReusableFieldSchemaWithChannelContext(this WebPageItemCacheDependencyBuilder builder, IEnumerable<string> reusableFieldSchemaNames, string languageName = null)

Parameters

builder WebPageItemCacheDependencyBuilder

Web page item cache dependency builder.

reusableFieldSchemaNames IEnumerable<string>

Collection of the reusable field schema names.

languageName string

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

Returns

WebPageItemCacheDependencyBuilder

The WebPageItemCacheDependencyBuilder instance for method chaining.

ByReusableFieldSchemaWithChannelContext(WebPageItemCacheDependencyBuilder, string, string)

Adds a dependency on web page items with the given reusable field schema assigned in the current channel from the website context.

public static WebPageItemCacheDependencyBuilder ByReusableFieldSchemaWithChannelContext(this WebPageItemCacheDependencyBuilder builder, string reusableFieldSchemaName, string languageName = null)

Parameters

builder WebPageItemCacheDependencyBuilder

Web page item cache dependency builder.

reusableFieldSchemaName string

Name of the reusable field schema.

languageName string

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

Returns

WebPageItemCacheDependencyBuilder

The WebPageItemCacheDependencyBuilder instance for method chaining.

ByReusableFieldSchemaWithContext(WebPageItemCacheDependencyBuilder, IEnumerable<string>)

Adds dependencies on web page items with the given reusable field schemas assigned in the current channel and preferred language from the website context.

public static WebPageItemCacheDependencyBuilder ByReusableFieldSchemaWithContext(this WebPageItemCacheDependencyBuilder builder, IEnumerable<string> reusableFieldSchemaNames)

Parameters

builder WebPageItemCacheDependencyBuilder

Web page item cache dependency builder.

reusableFieldSchemaNames IEnumerable<string>

Collection of the reusable field schema names.

Returns

WebPageItemCacheDependencyBuilder

The WebPageItemCacheDependencyBuilder instance for method chaining.

ByReusableFieldSchemaWithContext(WebPageItemCacheDependencyBuilder, string)

Adds a dependency on web page items with the given reusable field schema assigned in the current channel and preferred language from the website context.

public static WebPageItemCacheDependencyBuilder ByReusableFieldSchemaWithContext(this WebPageItemCacheDependencyBuilder builder, string reusableFieldSchemaName)

Parameters

builder WebPageItemCacheDependencyBuilder

Web page item cache dependency builder.

reusableFieldSchemaName string

Name of the reusable field schema.

Returns

WebPageItemCacheDependencyBuilder

The WebPageItemCacheDependencyBuilder instance for method chaining.

ByReusableFieldSchemaWithLanguageContext(WebPageItemCacheDependencyBuilder, IEnumerable<string>, string)

Adds a dependency on web page items with the given reusable field schema assigned in the preferred language from the website context.

public static WebPageItemCacheDependencyBuilder ByReusableFieldSchemaWithLanguageContext(this WebPageItemCacheDependencyBuilder builder, IEnumerable<string> reusableFieldSchemaNames, string channelName)

Parameters

builder WebPageItemCacheDependencyBuilder

Web page item cache dependency builder.

reusableFieldSchemaNames IEnumerable<string>

Collection of the reusable field schema names.

channelName string

Name of the channel that limits web page items considered.

Returns

WebPageItemCacheDependencyBuilder

The WebPageItemCacheDependencyBuilder instance for method chaining.

ByReusableFieldSchemaWithLanguageContext(WebPageItemCacheDependencyBuilder, string, string)

Adds a dependency on web page items with the given reusable field schema assigned in the preferred language from the website context.

public static WebPageItemCacheDependencyBuilder ByReusableFieldSchemaWithLanguageContext(this WebPageItemCacheDependencyBuilder builder, string reusableFieldSchemaName, string channelName)

Parameters

builder WebPageItemCacheDependencyBuilder

Web page item cache dependency builder.

reusableFieldSchemaName string

Name of the reusable field schema.

channelName string

Name of the channel that limits web page items considered.

Returns

WebPageItemCacheDependencyBuilder

The WebPageItemCacheDependencyBuilder instance for method chaining.