IAgentState.LoadAsync(ITurnContext, Boolean, 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.
Populates state from the storage layer.
public System.Threading.Tasks.Task LoadAsync(Microsoft.Agents.Builder.ITurnContext turnContext, bool force = false, System.Threading.CancellationToken cancellationToken = default);abstract member LoadAsync : Microsoft.Agents.Builder.ITurnContext * bool * System.Threading.CancellationToken -> System.Threading.Tasks.TaskPublic Function LoadAsync (turnContext As ITurnContext, Optional force As Boolean = false, Optional cancellationToken As CancellationToken = Nothing) As TaskParameters
- turnContext
- ITurnContext
The context object for this turn.
- force
- Boolean
Optional, true to overwrite any existing state cache;
or false to load state from storage only if the cache doesn't already exist.
- cancellationToken
- CancellationToken
A cancellation token that can be used by other objects or threads to receive notice of cancellation.
Returns
A task that represents the work queued to execute.
Exceptions
turnContext is null.
Remarks
LoadAsync loads State for the specified turn.