Teams App Test Tool for Message Extension FAQ - OfficeDev/TeamsFx GitHub Wiki
The "Command ID" and "Parameter name" Parameters in Search Command
In Teams, when you type in search box within a search-based message extension app, your app will receive an invoke activity with these two parameters. In rare cases, you app could use activity.value.commandId
or activity.value.parameters[0].name
to control different behaviors of search command in the activity handler for the composeExtension/query
invoke activty (e.g. handleTeamsMessagingExtensionQuery
method in botbuilder-js
SDK). But most of the time, you app doesn't need it because Teams only support a single search command and you can leave them empty.
In case your app reads these two parameters, you can expand the inputs by clicking Specify Command ID or Parameter
and fill in the values. When searching, Teams App Test Tool will send these two parameters in the invoke activity payload. If not set, the activity payload won't contain them.
In Teams, this information is retrieved from your app's manifest. However, Teams App Test Tool doesn't process the manifest (see Limitations), so you need to manually specify it.
For details about the schema of this invoke activity payload, please refer to Teams documentation
The "Command ID" Parameter in Action Command
In Teams, throughout the process of stepping through the dialogs triggered from action commands, your app will receive an composeExtension/fetchTask
or composeExtension/submitAction
invoke activity that contains the activity.value.commandId
parameter. Usually, you app uses it to dispatch different commands in the activity handler for the composeExtension/fetchTask
or composeExtension/submitAction
invoke activty (e.g. handleTeamsMessagingExtensionFetchTask
or handleTeamsMessagingExtensionSubmitAction
method in botbuilder-js
SDK).
When testing different action commands, you need to specify it in the Command ID
input box. If not set, the activity payload won't contain them.
In Teams, this information is retrieved from your app's manifest. However, Teams App Test Tool doesn't process the manifest (see Limitations), so you need to manually specify it.
For details about the schema of this invoke activity payload, please refer to Create and send dialogs and Respond to the dialog submit action.
Static List of Parameters in Action Command
Static list of parameters is the simplest method to create dialog for action commands, however you can't control the formatting in this case.
If you select to create the dialog with a static list of parameters and when the user submits the dialog, the message extension app will receive an composeExtension/submitAction
invoke activity.
Normally, you can define a list of parameters in your app manifest. However, Teams App Test Tool doesn't process the manifest (see Limitations), so you need to manually specify it.
For the schema of the static list of parameters, please refer to Manifest Schema.