csharp

page_type	description	products	languages	extensions	urlFragment
sample	Demonstrating the feature of typeahead search (static, dynamic and dependant) control in Adaptive Cards using sent bot.	office-teams office office-365	csharp	contentType createdDate samples 12/24/2021 12:00:00 AM	officedev-microsoft-teams-samples-bot-type-ahead-search-adaptive-cards-csharp

Typeahead search control in Adaptive Cards C#

This sample shows the feature of typeahead search (static, dynamic and dependant) control in Adaptive Cards.

Included Features

• Bots
• Adaptive Cards (typeahead search)

Interaction with app

Try it yourself - experience the App in your Microsoft Teams client

Please find below demo manifest which is deployed on Microsoft Azure and you can try it yourself by uploading the app manifest (.zip file link below) to your teams and/or as a personal app. (Sideloading must be enabled for your tenant, see steps here).

Typeahead search control in Adaptive Cards: Manifest

Prerequisites

• .NET Core SDK version 6.0

  determine dotnet version

  dotnet --version

• dev tunnel or Ngrok (For local environment testing) latest version (any other tunneling software can also be used)

• Teams Microsoft Teams is installed and you have an account

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.

2. Setup for Bot

   • Register a Microsoft Entra ID aap registration in Azure portal.
   • 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.

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

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 (Application (client) ID)is the application app id
  • MicrosoftAppPassword - Generated from Step 1, also referred to as Client secret

• Open the code in Visual Studio

• File -> Open -> Project/Solution

• Navigate to folder where repository is cloned then samples/bot-type-ahead-search-adaptive-cards/csharp/TypeaheadSearch.sln

• Press F5 to run the project

5. Setup Manifest for Teams

• This step is specific to Teams.

  • Edit the manifest.json contained in the ./appPackage folder to replace your Microsoft App Id (that was created when you registered your app registration earlier) everywhere you see the place holder string {{Microsoft-App-Id}} (depending on the scenario the Microsoft App Id may occur multiple times in the manifest.json)
  • Edit the manifest.json for validDomains and 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 appPackage folder to create a manifest.zip (Make sure that zip file does not contains any subfolder otherwise you will get error while uploading your .zip package)

• Upload the manifest.zip to Teams (in the Apps view click "Upload a custom app")

  • Go to Microsoft Teams. From the lower left corner, select Apps
  • From the lower left corner, choose Upload a custom App
  • Go to your project directory, the ./appPackage folder, select the zip folder, and choose Open.
  • Select Add in the pop-up dialog box. Your app is uploaded to Teams.

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

Running the sample

Use the bot command staticsearch to get the card with static typeahead search control and use bot command dynamicsearch to get the card with dynamic typeahead search control.

Static search: Static typeahead search allows users to search from values specified within input.choiceset in the Adaptive Card payload.

Static tpyedhead detail after submission

Dynamic search: Dynamic typeahead search is useful to search and select data from large data sets. The data sets are loaded dynamically from the dataset specified in the card payload.

On Submit button click, the bot will return the choice that we have selected:

Dependant Dropdown search: Dependant typeahead search allows users to select data based on one of the dropdown if the data of the main dropdown changes the data of the dependant dropdown changes with it. The data sets are loaded dynamically from the dataset specified in the card payload.

On Submit button click, the bot will return the choice that we have selected:

Further reading

• Bot Framework Documentation
• Bot Basics
• Azure Bot Service Introduction
• Azure Bot Service Documentation
• Typeahead Search in Adaptive Cards