Share via

class Dialog::CustomCommandsConfig

  • Article
class Dialog::CustomCommandsConfig
  : public Dialog::DialogServiceConfig

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

Members

SetApplicationId

Syntax: public inline void SetApplicationId ( const std::string & applicationId );

Sets the corresponding backend application identifier.

Parameters

  • applicationId Application identifier.

GetApplicationId

Syntax: public inline std::string GetApplicationId ( ) const;

Gets the application identifier.

Returns

Speech Channel Secret Key.

FromSubscription

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

Creates a Custom Commands config instance with the specified application id, subscription key and region.

Parameters

  • appId Custom Commands application id.

  • 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.

FromAuthorizationToken

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

Creates a Custom Commands config instance with the specified application id 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

  • appId Custom Commands application id.

  • authToken The authorization token.

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

Returns

A shared pointer to the new bot framework config.