Share via

class Dialog::BotFrameworkConfig

  • Article
class Dialog::BotFrameworkConfig
  : public Dialog::DialogServiceConfig

Class that defines configurations for the dialog service connector object for using a Bot Framework backend.

Members

FromSubscription

Syntax: public inline static std::shared_ptr< BotFrameworkConfig > FromSubscription ( const std::string & subscription , const std::string & region );

Creates a bot framework service config instance with the specified subscription key and region.

Parameters

  • subscription Subscription key associated with the bot

  • region The region name (see the region page).

Returns

A shared pointer to the new bot framework config.

FromSubscription

Syntax: public inline static std::shared_ptr< BotFrameworkConfig > FromSubscription ( const std::string & subscription , const std::string & region , const std::string & bot_Id );

Creates a bot framework service config instance with the specified subscription key and region.

Parameters

  • subscription Subscription key associated with the bot

  • region The region name (see the region page).

  • bot_Id Identifier used to select a bot associated with this subscription.

Returns

A shared pointer to the new bot framework config.

FromAuthorizationToken

Syntax: public inline static std::shared_ptr< BotFrameworkConfig > FromAuthorizationToken ( const std::string & authToken , const std::string & region );

Creates a bot framework service config instance with the specified authorization token and region. Note: The caller needs to ensure that the authorization token is valid. Before the authorization token expires, the caller needs to refresh it by calling this setter with a new valid token. As configuration values are copied when creating a new connector, the new token value will not apply to connectors that have already been created. For connectors that have been created before, you need to set authorization token of the corresponding connector to refresh the token. Otherwise, the connectors will encounter errors during operation.

Parameters

  • authToken The authorization token.

  • region The region name (see the region page).

Returns

A shared pointer to the new bot framework config.

FromAuthorizationToken

Syntax: public inline static std::shared_ptr< BotFrameworkConfig > FromAuthorizationToken ( const std::string & authToken , const std::string & region , const std::string & bot_Id );

Creates a bot framework service config instance with the specified authorization token and region. Note: The caller needs to ensure that the authorization token is valid. Before the authorization token expires, the caller needs to refresh it by calling this setter with a new valid token. As configuration values are copied when creating a new connector, the new token value will not apply to connectors that have already been created. For connectors that have been created before, you need to set authorization token of the corresponding connector to refresh the token. Otherwise, the connectors will encounter errors during operation.

Parameters

  • authToken The authorization token.

  • region The region name (see the region page).

  • bot_Id Identifier used to select a bot associated with this subscription.

Returns

A shared pointer to the new bot framework config.