csharp

page_type	description	products	languages	extensions	urlFragment
sample	Microsoft Teams Create Commands Menu	office-teams office office-365	csharp	contentType createdDate samples 05/17/2024 01:38:25 PM	officedev-microsoft-teams-samples-bot-commands-menu-csharp

Create a commands menu

This sample add a command menu with a dropdown list of commands for your bot. Users can select a command from the list, which will insert the command title into the compose box. Then, they can select Send to execute the command.

Included Features

• Bots

Interaction with app

Prerequisites

Verify you have the right account for building Teams apps and install some recommended development tools.

• You need a Teams account that allows custom app sideloading.
• .NET Core SDK version 6.0
• dev tunnel or ngrok latest version or equivalent tunnelling solution
• Teams Toolkit for Visual Studio

Run the app (Using Teams Toolkit for Visual Studio)

The simplest way to run this sample in Teams is to use Teams Toolkit for Visual Studio.

1. Install Visual Studio 2022 Version 17.10 Preview 4 or higher Visual Studio
2. Install Teams Toolkit for Visual Studio Teams Toolkit extension
3. In the debug dropdown menu of Visual Studio, select Dev Tunnels > Create A Tunnel (set authentication type to Public) or select an existing public dev tunnel.
4. In the debug dropdown menu of Visual Studio, select default startup project > Microsoft Teams (browser)
5. In Visual Studio, right-click your TeamsApp project and Select Teams Toolkit > Prepare Teams App Dependencies
6. Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps.
7. Select Debug > Start Debugging or F5 to run the menu in Visual Studio.
8. In the browser that launches, select the Add button to install the app to Teams.

If you do not have permission to upload custom apps (sideloading), Teams Toolkit will recommend creating and using a Microsoft 365 Developer Program account - a free program to get your own dev environment sandbox that includes Teams.

Setup

1. Register a new application in the Microsoft Entra ID – App Registrations portal.

   NOTE: When you create your app registration, you will create an App ID and App password (Secret) - make sure you keep these for later.

2. Setup for Bot

   • Also, register a bot with Azure Bot Service, following the instructions here
   • Ensure that you've enabled the Teams Channel
   • While registering the bot, use https://<your_tunnel_domain>/api/messages as the messaging endpoint.

3. Setup NGROK

• Run ngrok - point to port 3978

  ngrok http 3978 --host-header="localhost:3978"

  Alternatively, you can also use the dev tunnels. Please follow Create and host a dev tunnel and host the tunnel with anonymous user access command as shown below:

  devtunnel host -p 3978 --allow-anonymous

4. Setup for code

• Clone the repository

  git clone https://github.com/OfficeDev/Microsoft-Teams-Samples.git

• Modify the /appsettings.json and fill in the following details:

• {{MicrosoftAppId}} - Generated from Step 1 while doing Microsoft Entra ID app registration in Azure portal.

• {{MicrosoftAppPassword}} - Generated from Step 1, also referred to as Client secret

• Run the bot from a terminal or from Visual Studio:

5. If you are using Visual Studio

• Launch Visual Studio
• File -> Open -> Project/Solution
• Navigate to bot-commands-menu\csharp folder
• Select CommandsMenu.csproj file

6. This step is related to Microsoft Teams app manifest
   • Edit the manifest.json contained in the appPackage folder to replace your Microsoft App Id (that was created when you registered your bot earlier) everywhere you see the place holder string {{MicrosoftAppId}} and <> and for the contentUrl "<>?culture={locale}" (depending on the scenario the Microsoft App Id may occur multiple times in the manifest.json)
   • Provide turnnelling Url in manifest.json for contentUrl in case of tabs and for messaging endpoint in case of bots if enabled
   • replace {{domain-name}} with base Url of your domain. E.g. if you are using ngrok it would be https://1234.ngrok-free.app then your domain-name will be 1234.ngrok-free.app and if you are using dev tunnels then your domain will be like: 12345.devtunnels.ms.
   • Zip up the contents of the Manifest or Manifest_hub folder to create a manifest.zip
   • Upload the manifest.zip to Teams (in the Apps view click "Upload a custom app")

Note: If you are facing any issue in your app, please uncomment this line and put your debugger for local debug.

Running the sample

Install App Personal

Further reading

• Create a commands menu
• Create prompt suggestions