BotFrameworkConfigurationBuilder BotFrameworkConfigurationBuilder BotFrameworkConfigurationBuilder Class

Definition

public class BotFrameworkConfigurationBuilder
type BotFrameworkConfigurationBuilder = class
Public Class BotFrameworkConfigurationBuilder
Inheritance
BotFrameworkConfigurationBuilderBotFrameworkConfigurationBuilderBotFrameworkConfigurationBuilder

Constructors

BotFrameworkConfigurationBuilder(BotFrameworkOptions) BotFrameworkConfigurationBuilder(BotFrameworkOptions)

public BotFrameworkConfigurationBuilder (Microsoft.Bot.Builder.Integration.AspNet.WebApi.BotFrameworkOptions botFrameworkOptions);
new Microsoft.Bot.Builder.Integration.AspNet.WebApi.BotFrameworkConfigurationBuilder : Microsoft.Bot.Builder.Integration.AspNet.WebApi.BotFrameworkOptions -> Microsoft.Bot.Builder.Integration.AspNet.WebApi.BotFrameworkConfigurationBuilder
Parameters

Properties

BotFrameworkOptions BotFrameworkOptions BotFrameworkOptions

public Microsoft.Bot.Builder.Integration.AspNet.WebApi.BotFrameworkOptions BotFrameworkOptions { get; }
member this.BotFrameworkOptions : Microsoft.Bot.Builder.Integration.AspNet.WebApi.BotFrameworkOptions
Public ReadOnly Property BotFrameworkOptions As BotFrameworkOptions

Methods

EnableProactiveMessages(String) EnableProactiveMessages(String) EnableProactiveMessages(String)

Enables the proactive messaging endpoint and optionally allows specifying the path at which the endpoint should be exposed.

public Microsoft.Bot.Builder.Integration.AspNet.WebApi.BotFrameworkConfigurationBuilder EnableProactiveMessages (string proactiveMessagesPath = null);
member this.EnableProactiveMessages : string -> Microsoft.Bot.Builder.Integration.AspNet.WebApi.BotFrameworkConfigurationBuilder
Public Function EnableProactiveMessages (Optional proactiveMessagesPath As String = null) As BotFrameworkConfigurationBuilder
Parameters
proactiveMessagesPath
String String String

The path at which the proactive messaging endpoint should be exposed.

Returns

A reference to this instance after the operation has completed.

See Also

UseCredentialProvider(ICredentialProvider) UseCredentialProvider(ICredentialProvider) UseCredentialProvider(ICredentialProvider)

Configures an ICredentialProvider that should be used to store and retrieve credentials used during authentication with the Bot Framework.

public Microsoft.Bot.Builder.Integration.AspNet.WebApi.BotFrameworkConfigurationBuilder UseCredentialProvider (Microsoft.Bot.Connector.Authentication.ICredentialProvider credentialProvider);
member this.UseCredentialProvider : Microsoft.Bot.Connector.Authentication.ICredentialProvider -> Microsoft.Bot.Builder.Integration.AspNet.WebApi.BotFrameworkConfigurationBuilder
Public Function UseCredentialProvider (credentialProvider As ICredentialProvider) As BotFrameworkConfigurationBuilder
Parameters
credentialProvider
ICredentialProvider ICredentialProvider ICredentialProvider

An ICredentialProvider that the bot framework will use to authenticate requests.

Returns

A reference to this instance after the operation has completed.

See Also

UseMiddleware(IMiddleware) UseMiddleware(IMiddleware) UseMiddleware(IMiddleware)

Adds a piece of IMiddleware to the bot's middleware pipeline.

public Microsoft.Bot.Builder.Integration.AspNet.WebApi.BotFrameworkConfigurationBuilder UseMiddleware (Microsoft.Bot.Builder.IMiddleware middleware);
member this.UseMiddleware : Microsoft.Bot.Builder.IMiddleware -> Microsoft.Bot.Builder.Integration.AspNet.WebApi.BotFrameworkConfigurationBuilder
Public Function UseMiddleware (middleware As IMiddleware) As BotFrameworkConfigurationBuilder
Parameters
middleware
IMiddleware IMiddleware IMiddleware

An instance of IMiddleware that should be added to the bot's middleware pipeline.

Returns

A reference to this instance after the operation has completed.

See Also

UsePaths(Action) UsePaths(Action) UsePaths(Action)

Configures which paths should be used to expose the various endpoints of the bot.

public Microsoft.Bot.Builder.Integration.AspNet.WebApi.BotFrameworkConfigurationBuilder UsePaths (Action<Microsoft.Bot.Builder.Integration.AspNet.WebApi.BotFrameworkPaths> configurePaths);
member this.UsePaths : Action<Microsoft.Bot.Builder.Integration.AspNet.WebApi.BotFrameworkPaths> -> Microsoft.Bot.Builder.Integration.AspNet.WebApi.BotFrameworkConfigurationBuilder
Public Function UsePaths (configurePaths As Action(Of BotFrameworkPaths)) As BotFrameworkConfigurationBuilder
Parameters
configurePaths
Action<BotFrameworkPaths>

A callback to configure the paths that determine where the endpoints of the bot will be exposed.

Returns

A reference to this instance after the operation has completed.

See Also

UseRetryPolicy(RetryPolicy) UseRetryPolicy(RetryPolicy)

Adds retry policy on failure for BotFramework calls.

public Microsoft.Bot.Builder.Integration.AspNet.WebApi.BotFrameworkConfigurationBuilder UseRetryPolicy (Microsoft.Rest.TransientFaultHandling.RetryPolicy retryPolicy);
member this.UseRetryPolicy : Microsoft.Rest.TransientFaultHandling.RetryPolicy -> Microsoft.Bot.Builder.Integration.AspNet.WebApi.BotFrameworkConfigurationBuilder
Parameters
retryPolicy
Microsoft.Rest.TransientFaultHandling.RetryPolicy Microsoft.Rest.TransientFaultHandling.RetryPolicy Microsoft.Rest.TransientFaultHandling.RetryPolicy

The retry policy.

Returns

Applies to