CommandBot class

Package:

@microsoft/teamsfx

Warning

This API is now deprecated.

Use BotBuilderCloudAdapter.CommandBot instead.

Constructors

CommandBot(BotFrameworkAdapter, CommandOptions, BotSsoExecutionActivityHandler, BotSsoConfig)

Creates a new instance of the CommandBot.

Methods

registerCommand(TeamsFxBotCommandHandler)	Registers a command into the command bot.
registerCommands(TeamsFxBotCommandHandler[])	Registers commands into the command bot.
registerSsoCommand(TeamsFxBotSsoCommandHandler)	Registers a sso command into the command bot.
registerSsoCommands(TeamsFxBotSsoCommandHandler[])	Registers commands into the command bot.

Constructor Details

CommandBot(BotFrameworkAdapter, CommandOptions, BotSsoExecutionActivityHandler, BotSsoConfig)

Creates a new instance of the CommandBot.

new CommandBot(adapter: BotFrameworkAdapter, options?: CommandOptions, ssoCommandActivityHandler?: BotSsoExecutionActivityHandler, ssoConfig?: BotSsoConfig)

Parameters

adapter

BotFrameworkAdapter

The bound BotFrameworkAdapter.

options

CommandOptions

initialize options

ssoCommandActivityHandler

BotSsoExecutionActivityHandler

ssoConfig

BotSsoConfig

Method Details

registerCommand(TeamsFxBotCommandHandler)

Registers a command into the command bot.

function registerCommand(command: TeamsFxBotCommandHandler)

Parameters

command

TeamsFxBotCommandHandler

The command to register.

registerCommands(TeamsFxBotCommandHandler[])

Registers commands into the command bot.

function registerCommands(commands: TeamsFxBotCommandHandler[])

Parameters

commands

TeamsFxBotCommandHandler[]

The commands to register.

registerSsoCommand(TeamsFxBotSsoCommandHandler)

Registers a sso command into the command bot.

function registerSsoCommand(ssoCommand: TeamsFxBotSsoCommandHandler)

Parameters

ssoCommand

TeamsFxBotSsoCommandHandler

registerSsoCommands(TeamsFxBotSsoCommandHandler[])

Registers commands into the command bot.

function registerSsoCommands(ssoCommands: TeamsFxBotSsoCommandHandler[])

Parameters

ssoCommands

TeamsFxBotSsoCommandHandler[]