IDistributedCacheProvider Plugin Type

Verint | Telligent Community — Wed, 14 May 2025 16:53:08 GMT

Current Revision posted to API Documentation by Verint | Telligent Community on 05/14/2025 16:53:08

A cache shared amongst all application nodes.

IDistributedCacheProvider is defined in the Telligent.Evolution.Extensibility.Caching.Version1 namespace.

Definition

interface IDistributedCacheProvider : [[ISingletonPlugin Plugin Type|ISingletonPlugin]]
{
	void Clear();
	Task ClearAsync();
	Byte Get(string key);
	Task<Byte> GetAsync(string key);
	void Put(string key, Byte value, string[] tags, TimeSpan? absoluteTimeout);
	Task PutAsync(string key, Byte value, string[] tags, TimeSpan? absoluteTimeout);
	void Remove(string key);
	Task RemoveAsync(string key);
	void RemoveByTags(string[] tags);
	Task RemoveByTagsAsync(string[] tags);
}

Methods

void Clear();

Remove all values.

Task ClearAsync();

Return Type

Task

Byte Get(string key);

Retrieves the value associated with the provided key, or null if the data does not exist in the cache.

Parameters

Name	Type	Description	Required	Default	Options
key	`string`	Key	Required

Return Type

Byte

Task<Byte> GetAsync(string key);

Parameters

Name	Type	Description	Required	Default	Options
key	`string`	Key	Required

Return Type

Task<Byte>

void Put(string key, Byte value, string[] tags, TimeSpan? absoluteTimeout);

Adds or updates the value associated with the provided key. Tags are shared identifiers associated to this cached value (tags can be null or empty). If absoluteTimeout has a value, the value is expected to expire from the cache after the provided duration (TimeSpan.Zero represents an infinite duration). If absoluteTimeout does not have a value, the cache is free to implement a default or a sliding expiration.

Parameters

Name	Type	Description	Required
key	`string`	Key	Required
value	`Byte`	Value	Required
tags	`string[]`	Tags	Required
absoluteTimeout	`TimeSpan?`	Absolute Timeout	Required

Task PutAsync(string key, Byte value, string[] tags, TimeSpan? absoluteTimeout);

Parameters

Name	Type	Description	Required
key	`string`	Key	Required
value	`Byte`	Value	Required
tags	`string[]`	Tags	Required
absoluteTimeout	`TimeSpan?`	Absolute Timeout	Required

Return Type

Task

void Remove(string key);

Removes the value associated with the key.

Parameters

Name	Type	Description	Required	Default	Options
key	`string`	Key	Required

Task RemoveAsync(string key);

Parameters

Name	Type	Description	Required	Default	Options
key	`string`	Key	Required

Return Type

Task

void RemoveByTags(string[] tags);

Removes values associated with at least one of the provided tags (shared identifiers).

Parameters

Name	Type	Description	Required	Default	Options
tags	`string[]`	Tags	Required

Task RemoveByTagsAsync(string[] tags);

Parameters

Name	Type	Description	Required	Default	Options
tags	`string[]`	Tags	Required

Return Type

Task