| CacheHelper Methods |
The CacheHelper type exposes the following members.
Methods| Name | Description | |
|---|---|---|
  | Add(String, Object, CMSCacheDependency, DateTime, TimeSpan) |
Mirror to Cache.Add().
|
| Add(String, Object, CMSCacheDependency, DateTime, TimeSpan, CMSCacheItemPriority, CMSCacheItemRemovedCallback, Boolean) |
Mirror to Cache.Add().
|
 | AddInternal |
Mirror to Cache.Add().
|
| BuildCacheItemName |
Builds the cache item name from the given parts
|
| CacheTData(FuncTData, CacheSettings) |
Wraps the operation to a cached section. This method supports progressive caching and is able to distribute unhandled exceptions to other simultaneously running threads.
|
| CacheTData(FuncCacheSettings, TData, CacheSettings) |
Wraps the operation to a cached section. This method supports progressive caching and is able to distribute unhandled exceptions to other simultaneously running threads.
|
| CacheAsyncTData(FuncTaskTData, CacheSettings) |
Asynchronously loads data. If multiple threads are loading the same data, only one thread executes the load, stores the result into cache and the result is distributed to other waiting threads.
If an exception is thrown during loadMethodAsync execution, the exception is distributed as well. No data are cached in such a case.
|
| CacheAsyncTData(FuncCacheSettings, TaskTData, CacheSettings) |
Asynchronously loads data. If multiple threads are loading the same data, only one thread executes the load, stores the result into cache and the result is distributed to other waiting threads.
If an exception is thrown during loadMethodAsync execution, the exception is distributed as well. No data are cached in such a case.
|
| CacheAsyncTData(FuncCancellationToken, TaskTData, CacheSettings, CancellationToken) |
Asynchronously loads data. If multiple threads are loading the same data, only one thread executes the load, stores the result into cache and the result is distributed to other waiting threads.
If an exception is thrown during loadMethodAsync execution, the exception is distributed as well. No data are cached in such a case.
|
| CacheAsyncTData(FuncCacheSettings, CancellationToken, TaskTData, CacheSettings, CancellationToken) |
Asynchronously loads data. If multiple threads are loading the same data, only one thread executes the load, stores the result into cache and the result is distributed to other waiting threads.
If an exception is thrown during loadMethodAsync execution, the exception is distributed as well. No data are cached in such a case.
|
| CacheEnabled |
Returns true if the content caching is enabled.
|
| CacheImageAllowed |
Checks if the file attachment is below the maximum file size used for caching.
|
| CacheImageEnabled |
Returns true if the image caching is enabled.
|
| CacheImageMinutes |
Cache image minutes.
|
| CacheMinutes |
Cache content minutes.
|
| ClearCache |
Clears the entire system cache.
|
| ClearCache(String, Boolean, Boolean) |
Clears the cache content starting with given string. Clears also full page cache (including persistent) when called on website.
|
| ClearCSSCache |
Clear the CSS cache
|
| ClearFileNodeCache |
Clear the cache for the file document nodes.
|
| ClearFullPageCache | Obsolete.
Clear the full page cache (output cache) of the pages.
|
| ClearFullPageCacheInternal | Obsolete.
Clear the full page cache (output cache) of the pages.
|
| ClientCacheMinutes |
Client cache minutes for the processed content (both files and pages).
|
| CompactCache |
Tries to remove the specified percentage of items from the underlying cache.
The return value indicates whether compacting was performed (i.e. whether the underlying cache supports compacting).
|
| CreateCacheDependencyInternal |
Creates the cache dependency with specified parameters
|
| EnsureDummyKey |
Ensures the dummy key with the given name
|
| EnsureKey |
Ensures the specified cache key.
|
| GetBaseCacheKey |
Returns the base cache key (created with all parameters considered to be valid for proper caching).
|
| GetCacheDependencies |
Processes the dependencies string. Returns default dependencies if the source is null or empty.
If source is NO_CACHE_DEPENDENCY constant, then method also returns this constant.
When source is specified and contains DEFAULT_CACHE_DEPENDENCIES constant, then this constant
indicates that default dependencies should be appended to the source. The DEFAULT_CACHE_DEPENDENCIES also remains
in the string so other processes can insert their default dependencies.
|
| GetCacheDependency(ICollectionString) |
Creates the cache dependency from the given keys.
|
| GetCacheDependency(String) |
Creates the cache dependency from the given keys.
|
| GetCacheDependency(String) |
Creates the cache dependency from the given keys.
|
| GetCacheDependency(ListString, ICollectionString) |
Creates the cache dependency from the given keys.
|
| GetCacheDependency(String, String) |
Creates the cache dependency from the given keys.
|
| GetCacheItemName(String, Object) |
Gets the cache item string.
|
| GetCacheItemName(Boolean, String, Object) |
Gets the cache item string.
|
| GetCacheItemRows |
Creates a list of all cache items to display in the Debug application.
|
| GetCacheItemsString |
Gets the cache items string (item names separated by semicolon)
|
| GetCombinedCacheItems |
Gets combined cache items for setting and default items
|
| GetCultureCacheKey |
Gets the cache key for current culture
|
| GetCultureCacheKey(String) |
Gets the cache key for the given culture
|
| GetDependencyCacheKeys |
Parses the string and returns the array of the cache dependency keys.
|
| GetEnumeratorInternal |
Gets the enumerator for the cache items.
|
| GetFileCacheDependency |
Creates the cache dependency from the given file path.
|
| GetFullKey |
Gets the full cache key with the prefix
|
| GetFullKeyInternal |
Gets the full cache key with the prefix
|
| GetInnerValue |
Gets the inner value for the cache item
|
| GetInternal |
Gets the item from the cache.
|
| GetItem |
Gets item from cache.
|
| GetUserCacheKey |
Gets the cache key for current user
|
| GetUserCacheKey(String) |
Gets the cache key for current user the given user
|
| InsertInternal |
Inserts the item into the cache.
|
| MaxCacheFileSize |
Maximum size of the file that is allowed to be cached in kilobytes.
|
| RegisterAutomaticCallback | Obsolete.
Registers the automatic callback that is executed at the specific time
|
| RegisterDependencyCallbackTTarget |
Registers a cache callback for given list of cache dependencies
|
| Remove |
Removes object from cache.
|
| RemoveDependencyCallback |
Registers a cache callback for given list of cache dependencies
|
| RemoveInternal |
Removes the item from the cache.
|
| RevalidateClientCache |
Returns whether the client cache should be revalidated by the call to the server.
|
| SetAsDefaultHelper |
Sets this object as the default helper
(Inherited from AbstractHelperHelperType.) |
| TouchKey(String) |
Touches the cache key to drop the dependencies.
|
| TouchKey(String, Boolean, Boolean) |
Touches the cache key to drop the dependencies.
|
| TouchKey(String, Boolean, Boolean, DateTime) |
Touches the cache key to drop the dependencies.
|
| TouchKey(String, Boolean, Boolean, DateTime, Boolean) |
Touches the cache key to drop the dependencies.
|
| TouchKeyInternal |
Touches the cache key to drop the dependencies.
|
| TouchKeys(IEnumerableString) |
Touches the cache key to drop the dependencies.
|
| TouchKeys(IEnumerableString, Boolean, Boolean) |
Touches the cache key to drop the dependencies.
|
| TouchKeys(String, Boolean, Boolean) |
Touches the cache keys separated by new line to drop the dependencies.
|
| TouchKeysInternal |
Touches the cache key to drop the dependencies.
|
| TryGetItem(String, Object) |
Returns true if the cache contains the item with specified key.
|
| TryGetItem(String, Boolean, Object) |
Returns true if the cache contains the item with specified key.
|
| TryGetItemOutputType(String, OutputType) |
Returns true if the cache contains the item with specified key.
|
| TryGetItemOutputType(String, Boolean, OutputType, Boolean) |
Returns true if the cache contains the item with specified key.
|
See Also