IDistributedCache.RefreshAsync(String, CancellationToken) Method

Definition

Namespace:

Microsoft.Extensions.Caching.Distributed

Assembly:

Microsoft.Extensions.Caching.Abstractions.dll

Package:

Microsoft.Extensions.Caching.Abstractions v10.0.0-preview.2.25163.2

Source:

IDistributedCache.cs

Refreshes a value in the cache based on its key, resetting its sliding expiration timeout (if any).

public System.Threading.Tasks.Task RefreshAsync(string key, System.Threading.CancellationToken token = default);

Parameters

key

String

A string identifying the requested value.

token

CancellationToken

Optional. The CancellationToken used to propagate notifications that the operation should be canceled.

Returns

Task

The Task that represents the asynchronous operation.

Exceptions

OperationCanceledException

The cancellation token was canceled. This exception is stored into the returned task.

Remarks

This method stores in the task it returns all non-usage exceptions that the method's synchronous counterpart can throw. If an exception is stored into the returned task, that exception will be thrown when the task is awaited. Usage exceptions, such as ArgumentException, are still thrown synchronously. For the stored exceptions, see the exceptions thrown by Refresh(String).