View Source

Interface IAppCache

Defines an application cache.

Namespace: Umbraco.Cms.Core.Cache
Assembly: Umbraco.Core.dll
Syntax
public interface IAppCache

Methods

View Source

Clear()

Removes all items from the cache.

Declaration
void Clear()
View Source

Clear(String)

Removes an item identified by its key from the cache.

Declaration
void Clear(string key)
Parameters
Type Name Description
System.String key

The key of the item.
View Source

ClearByKey(String)

Clears items with a key starting with the specified value.

Declaration
void ClearByKey(string keyStartsWith)
Parameters
Type Name Description
System.String keyStartsWith

The StartsWith value to use in the search.
View Source

ClearByRegex(String)

Clears items with a key matching a regular expression.

Declaration
void ClearByRegex(string regex)
Parameters
Type Name Description
System.String regex

The regular expression.
View Source

ClearOfType(Type)

Removes items of a specified type from the cache.

Declaration
void ClearOfType(Type type)
Parameters
Type Name Description
Type type

The type to remove.
Remarks

If the type is an interface, then all items of a type implementing that interface are removed. Otherwise, only items of that exact type are removed (items of type inheriting from the specified type are not removed).

Performs a case-sensitive search.

View Source

ClearOfType<T>()

Removes items of a specified type from the cache.

Declaration
void ClearOfType<T>()
Type Parameters
Name Description
T

The type of the items to remove.
Remarks

If the type is an interface, then all items of a type implementing that interface are removed. Otherwise, only items of that exact type are removed (items of type inheriting from the specified type are not removed).

View Source

ClearOfType<T>(Func<String, T, Boolean>)

Removes items of a specified type from the cache.

Declaration
void ClearOfType<T>(Func<string, T, bool> predicate)
Parameters
Type Name Description
Func<System.String, T, System.Boolean> predicate

The predicate to satisfy.
Type Parameters
Name Description
T

The type of the items to remove.
Remarks

If the type is an interface, then all items of a type implementing that interface are removed. Otherwise, only items of that exact type are removed (items of type inheriting from the specified type are not removed).

View Source

Get(String)

Gets an item identified by its key.

Declaration
object Get(string key)
Parameters
Type Name Description
System.String key

The key of the item.
Returns
Type Description
System.Object

The item, or null if the item was not found.
View Source

Get(String, Func<Object>)

Gets or creates an item identified by its key.

Declaration
object Get(string key, Func<object> factory)
Parameters
Type Name Description
System.String key

The key of the item.
Func<System.Object> factory

A factory function that can create the item.
Returns
Type Description
System.Object

The item.
Remarks

Null values returned from the factory function are never cached.

View Source

SearchByKey(String)

Gets items with a key starting with the specified value.

Declaration
IEnumerable<object> SearchByKey(string keyStartsWith)
Parameters
Type Name Description
System.String keyStartsWith

The StartsWith value to use in the search.
Returns
Type Description
IEnumerable<System.Object>

Items matching the search.
View Source

SearchByRegex(String)

Gets items with a key matching a regular expression.

Declaration
IEnumerable<object> SearchByRegex(string regex)
Parameters
Type Name Description
System.String regex

The regular expression.
Returns
Type Description
IEnumerable<System.Object>

Items matching the search.