GroupChatManager.OnCheckpointRestoredAsync 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.
Invoked when the hosting group chat workflow is being restored from a checkpoint, giving subclasses a chance to hydrate any additional state they persisted in OnCheckpointingAsync(IWorkflowContext, CancellationToken).
protected virtual System.Threading.Tasks.ValueTask OnCheckpointRestoredAsync(Microsoft.Agents.AI.Workflows.IWorkflowContext context, System.Threading.CancellationToken cancellationToken = default);abstract member OnCheckpointRestoredAsync : Microsoft.Agents.AI.Workflows.IWorkflowContext * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTask
override this.OnCheckpointRestoredAsync : Microsoft.Agents.AI.Workflows.IWorkflowContext * System.Threading.CancellationToken -> System.Threading.Tasks.ValueTaskProtected Overridable Function OnCheckpointRestoredAsync (context As IWorkflowContext, Optional cancellationToken As CancellationToken = Nothing) As ValueTaskParameters
- context
- IWorkflowContext
A wrapped workflow context that scopes state keys to the GroupChatManager subclass namespace.
- cancellationToken
- CancellationToken
The CancellationToken to monitor for cancellation requests. The default is None.
Returns
Remarks
The default implementation is a no-op. Base-class state (currently IterationCount) is restored automatically by the hosting Microsoft.Agents.AI.Workflows.Specialized.GroupChatHost before this method is invoked; subclasses do not need to call base.OnCheckpointRestoredAsync. The supplied context uses the same key-prefixing wrapper as OnCheckpointingAsync(IWorkflowContext, CancellationToken).