Interface IContentCacheKeyCreator
Handle generation of Cache key
Namespace: EPiServer.Core
Assembly: EPiServer.dll
Version: 12.0.3Syntax
public interface IContentCacheKeyCreatorProperties
RemoteCacheUpdateLimit
Number of items that to prevent updating remote cache.
Declaration
int RemoteCacheUpdateLimit { get; }Property Value
| Type | Description |
|---|---|
| System.Int32 |
RootKeyName
Everything stored in the Content cache has a dependency on this key.
Declaration
string RootKeyName { get; }Property Value
| Type | Description |
|---|---|
| System.String |
VersionKey
A global key that content cache updates with a new version number everytime a content or listing is removed from cache. Targeted for use with output caching and other caching mechanism that cannot rely on a single item or content in EPiServer.
Declaration
string VersionKey { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Remarks
Does not update when content versions are changed
Methods
CreateChildrenCacheKey(ContentReference, String)
Create the key used to store/retrieve children from the cache for a specific language
Declaration
string CreateChildrenCacheKey(ContentReference contentLink, string languageID)Parameters
| Type | Name | Description |
|---|---|---|
| ContentReference | contentLink | The content that has the children. |
| System.String | languageID | The language for which the listing was made |
Returns
| Type | Description |
|---|---|
| System.String | A string which is the cache key. |
CreateCommonCacheKey(ContentReference)
Create the cache key used to relate the different languages of a Content to each other
Declaration
string CreateCommonCacheKey(ContentReference contentLink)Parameters
| Type | Name | Description |
|---|---|---|
| ContentReference | contentLink | The content link. |
Returns
| Type | Description |
|---|---|
| System.String |
CreateLanguageCacheKey(ContentReference, String)
Create the key used to store/retrieve a IContent object of a specific language from the cache.
Declaration
string CreateLanguageCacheKey(ContentReference contentLink, string languageBranch)Parameters
| Type | Name | Description |
|---|---|---|
| ContentReference | contentLink | A ContentReference object for the IContent to store/retrieve. |
| System.String | languageBranch | The language branch for which the key should be created. If languageBranch is null, a master language cache key is created |
Returns
| Type | Description |
|---|---|
| System.String | A string which is the cache key. |
CreateMasterLanguageCacheKey(ContentReference)
Create the key used to store/retrieve the IContent object that is Master Language
Declaration
string CreateMasterLanguageCacheKey(ContentReference contentLink)Parameters
| Type | Name | Description |
|---|---|---|
| ContentReference | contentLink | A ContentReference object for the IContent to store/retrieve. |
Returns
| Type | Description |
|---|---|
| System.String | A string which is the cache key. |
CreateSegmentCacheKey(ContentReference, String)
Create the key used to store/retrieve matching url children segments for from the cache.
Declaration
string CreateSegmentCacheKey(ContentReference parentLink, string urlSegment)Parameters
| Type | Name | Description |
|---|---|---|
| ContentReference | parentLink | A ContentReference object for the IContent which child segments is to be matched. |
| System.String | urlSegment | The URL segment that is matched for. |
Returns
| Type | Description |
|---|---|
| System.String | A string which is the cache key. |
CreateVersionCacheKey(ContentReference)
Creates the cache key used to cache a specific version of a content.
Declaration
string CreateVersionCacheKey(ContentReference contentLink)Parameters
| Type | Name | Description |
|---|---|---|
| ContentReference | contentLink | The content link. |
Returns
| Type | Description |
|---|---|
| System.String |
CreateVersionCommonCacheKey(ContentReference)
Creates the common cache key used to clear all cached versions for a given content item.
Declaration
string CreateVersionCommonCacheKey(ContentReference contentLink)Parameters
| Type | Name | Description |
|---|---|---|
| ContentReference | contentLink | The content link. |
Returns
| Type | Description |
|---|---|
| System.String |
ResolveCacheKey(String, out Int32)
Resolves the cache key into a content reference.
Declaration
string ResolveCacheKey(string cacheKey, out int contentLinkID)Parameters
| Type | Name | Description |
|---|---|---|
| System.String | cacheKey | The cache key. |
| System.Int32 | contentLinkID | The content link ID. |
Returns
| Type | Description |
|---|---|
| System.String | The cache key prefic of the cache key. |
