ActionExecutor Class
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.
Base class for action executors that do not consume the input message (most).
public abstract class ActionExecutor : Microsoft.Agents.AI.Workflows.Declarative.Kit.ActionExecutor<Microsoft.Agents.AI.Workflows.Declarative.Kit.ActionExecutorResult>type ActionExecutor = class
inherit ActionExecutor<ActionExecutorResult>Public MustInherit Class ActionExecutor
Inherits ActionExecutor(Of ActionExecutorResult)- Inheritance
- Derived
Constructors
| Name | Description |
|---|---|
| ActionExecutor(String, FormulaSession) |
Base class for action executors that do not consume the input message (most). |
Properties
| Name | Description |
|---|---|
| Id |
A unique identifier for the executor. (Inherited from Executor) |
| InputTypes |
A set of Types, representing the messages this executor can handle. (Inherited from Executor) |
| Options |
Gets the configuration options for the executor. (Inherited from Executor) |
| OutputTypes |
A set of Types, representing the messages this executor can produce as output. (Inherited from Executor) |
Methods
| Name | Description |
|---|---|
| CanHandle(Type) |
Checks if the executor can handle a specific message type. (Inherited from Executor) |
| ConfigureRoutes(RouteBuilder) |
Override this method to register handlers for the executor. (Inherited from Executor<TInput>) |
| ConfigureSentTypes() |
Override this method to declare the types of messages this executor can send. (Inherited from Executor) |
| ConfigureYieldTypes() |
Override this method to declare the types of messages this executor can yield as workflow outputs. (Inherited from Executor) |
| DescribeProtocol() |
Describes the protocol for communication with this Executor. (Inherited from Executor) |
| ExecuteAsync(IWorkflowContext, ActionExecutorResult, CancellationToken) |
Executes the core logic of the action. |
| ExecuteAsync(IWorkflowContext, CancellationToken) |
Executes the core logic of the action. |
| ExecuteAsync(IWorkflowContext, TMessage, CancellationToken) |
Executes the core logic of the action. (Inherited from ActionExecutor<TMessage>) |
| ExecuteAsync(Object, TypeId, IWorkflowContext, CancellationToken) |
Process an incoming message using the registered handlers. (Inherited from Executor) |
| HandleAsync(TMessage, IWorkflowContext, CancellationToken) |
Handles the incoming message asynchronously. (Inherited from ActionExecutor<TMessage>) |
| InitializeAsync(IWorkflowContext, CancellationToken) |
Perform any asynchronous initialization required by the executor. This method is called once per executor instance, (Inherited from Executor) |
| IsMatch<TValue>(TValue, Object) |
Test wether the provided value matches the value returned by the prior executor. |
| OnCheckpointingAsync(IWorkflowContext, CancellationToken) |
Invoked before a checkpoint is saved, allowing custom pre-save logic in derived classes. (Inherited from Executor) |
| OnCheckpointRestoredAsync(IWorkflowContext, CancellationToken) |
Invoked after a checkpoint is loaded, allowing custom post-load logic in derived classes. (Inherited from Executor) |
| ResetAsync() |
Reset the executor (Inherited from ActionExecutor<TMessage>) |
Extension Methods
| Name | Description |
|---|---|
| BindExecutor(Executor) |
Configures an Executor instance for use in a workflow. |