HostApplicationBuilderWorkflowExtensions.AddWorkflow Method

Definition

Namespace:

Microsoft.Agents.AI.Hosting

Assembly:

Microsoft.Agents.AI.Hosting.dll

Package:

Microsoft.Agents.AI.Hosting v1.0.0-preview.260108.1

Registers a custom workflow using a factory delegate.

public static Microsoft.Agents.AI.Hosting.IHostedWorkflowBuilder AddWorkflow(this Microsoft.Extensions.Hosting.IHostApplicationBuilder builder, string name, Func<IServiceProvider,string,Microsoft.Agents.AI.Workflows.Workflow> createWorkflowDelegate);

static member AddWorkflow : Microsoft.Extensions.Hosting.IHostApplicationBuilder * string * Func<IServiceProvider, string, Microsoft.Agents.AI.Workflows.Workflow> -> Microsoft.Agents.AI.Hosting.IHostedWorkflowBuilder

<Extension()>
Public Function AddWorkflow (builder As IHostApplicationBuilder, name As String, createWorkflowDelegate As Func(Of IServiceProvider, String, Workflow)) As IHostedWorkflowBuilder

Parameters

builder

IHostApplicationBuilder

The IHostApplicationBuilder to configure.

name

String

The unique name for the workflow.

createWorkflowDelegate

Func<IServiceProvider,String,Workflow>

A factory function that creates the Workflow instance. The function receives the service provider and workflow name as parameters.

Returns

IHostedWorkflowBuilder

An IHostedWorkflowBuilder that can be used to further configure the workflow.

Exceptions

ArgumentNullException

Thrown when builder, name, or createWorkflowDelegate is null.

ArgumentException

Thrown when name is empty.

InvalidOperationException

Thrown when the factory delegate returns null or a workflow with a name that doesn't match the expected name.