IActorStateManager.TryRemoveStateAsync(String, CancellationToken) Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Attempts to remove an actor state with specified state name.
public System.Threading.Tasks.Task<bool> TryRemoveStateAsync (string stateName, System.Threading.CancellationToken cancellationToken = default);
abstract member TryRemoveStateAsync : string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<bool>
Public Function TryRemoveStateAsync (stateName As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of Boolean)
Parameters
- stateName
- String
Name of the actor state to remove.
- cancellationToken
- CancellationToken
The token to monitor for cancellation requests.
Returns
A task that represents the asynchronous remove operation. The value of TResult parameter indicates if the state was successfully removed.
Exceptions
The specified state name is null.
The operation was canceled.