Interface IEnterprisePlatformBuilder

The builder object that builds the Enterprise Platform

Namespace: Microsoft.Bot.Builder.Enterprise.Core

Assembly: Microsoft.Bot.Builder.Enterprise.dll

Syntax

public interface IEnterprisePlatformBuilder

Properties

View Source

Id

Gets the platform id.

Declaration

string Id { get; }

Property Value

Type	Description
System.String

Methods

View Source

Build()

Build and return the enterprise platform object.

Declaration

IEnterprisePlatform Build()

Returns

Type	Description
IEnterprisePlatform	The IEnterprisePlatform.

View Source

SetAuthenticationProvider(IAuthProvider)

Sets the custom authentication provider.

Declaration

IEnterprisePlatformBuilder SetAuthenticationProvider(IAuthProvider provider)

Parameters

Type	Name	Description
IAuthProvider	provider	The authentication provider.

Returns

Type	Description
IEnterprisePlatformBuilder	The IEnterprisePlatformBuilder.

View Source

SetCallbackUrl(Uri)

Set the callback uri for your bot. This callback url acts as a entry point for both local media and remote media calls.

Declaration

IEnterprisePlatformBuilder SetCallbackUrl(Uri callbackUrl)

Parameters

Type	Name	Description
System.Uri	callbackUrl	The callback Url.

Returns

Type	Description
IEnterprisePlatformBuilder	The IEnterprisePlatformBuilder.

View Source

SetCallServiceHandler(ICallServiceHandler)

Set the call service handler that handles call setup.

Declaration

IEnterprisePlatformBuilder SetCallServiceHandler(ICallServiceHandler handler)

Parameters

Type	Name	Description
ICallServiceHandler	handler	The call service handler.

Returns

Type	Description
IEnterprisePlatformBuilder	The IEnterprisePlatformBuilder.

View Source

SetCredentials(String, String)

Set the credentials for authentication of bot.

Declaration

IEnterprisePlatformBuilder SetCredentials(string azureClientId, string azureClientSecret)

Parameters

Type	Name	Description
System.String	azureClientId	The client id of the bot
System.String	azureClientSecret	The client secret of the bot

Returns

Type	Description
IEnterprisePlatformBuilder	The IEnterprisePlatformBuilder.

View Source

SetPlaceCallEndpointUrl(Uri)

Sets the place call endpoint URL.

Declaration

IEnterprisePlatformBuilder SetPlaceCallEndpointUrl(Uri placeCallEndpointUrl)

Parameters

Type	Name	Description
System.Uri	placeCallEndpointUrl	The place call endpoint URL.

Returns

Type	Description
IEnterprisePlatformBuilder	The IEnterprisePlatformBuilder.

Exceptions

Type	Condition
System.ArgumentNullException	`placeCallEndpointUrl` is null
System.ArgumentException	uri must be https

View Source

SetupLogger(IEnterpriseLogger)

Provide a custom logger for hooking into the SDK.

Declaration

IEnterprisePlatformBuilder SetupLogger(IEnterpriseLogger enterpriseLogger)

Parameters

Type	Name	Description
IEnterpriseLogger	enterpriseLogger	The logger that implements IEnterpriseLogger interface.

Returns

Type	Description
IEnterprisePlatformBuilder	The IEnterprisePlatformBuilder.

View Source

UseStateManager()

Configure this platform to store the state for the calls in memory. Once this has been set, it cannot be unset without creating a new instance of the EnterprisePlatformBuilder.

Declaration

IEnterprisePlatformBuilder UseStateManager()

Returns

Type	Description
IEnterprisePlatformBuilder	The IEnterprisePlatformBuilder.