Skip to content

Latest commit

 

History

History
page_type description products languages extensions urlFragment
sample
This sample demonstrates using a bot to send multiple card types in Microsoft Teams, including Adaptive, Hero, Thumbnail, and OAuth cards. It covers setup, deployment, and app installation instructions.
office-teams
office
office-teams
csharp
contentType createdDate
samples
21/10/2022 07:54:21 PM
officedev-microsoft-teams-samples-bot-all-cards-csharp

Types of Cards

This Microsoft Teams bot sample demonstrates sending various card types, such as Adaptive, Hero, List, and Thumbnail cards. It includes detailed steps for setup, app deployment, and using Teams Toolkit for Visual Studio to run the app. Experience this versatile bot directly within your Teams client, complete with a manifest for easy sideloading.

Included Features

  • Bots
  • Adaptive Cards
  • Hero Cards
  • List Cards
  • O365 Connector Cards
  • List Cards
  • Thumbnail Cards
  • Collections Cards

Interaction with app

all-cards-sample

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 package (.zip file link below) to your teams and/or as a personal app. (Sideloading must be enabled for your tenant, see steps here).

Different types of cards: Manifest

Prerequisites

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

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

    1. Select New Registration and on the register an application page, set following values:

      • Set name to your app name.
      • Choose the supported account types (any account type will work)
      • Leave Redirect URI empty.
      • Choose Register.
    2. On the overview page, copy and save the Application (client) ID, Directory (tenant) ID. You’ll need those later when updating your Teams application manifest and in the appsettings.json.

    3. Navigate to Authentication If an app hasn't been granted IT admin consent, users will have to provide consent the first time they use an app.

      • Set another redirect URI:

    Authentication

    1. Navigate to the Certificates & secrets. In the Client secrets section, click on "+ New client secret". Add a description (Name of the secret) for the secret and select “Never” for Expires. Click "Add". Once the client secret is created, copy its value, it need to be placed in the appsettings.json.
  1. Setup for Bot
  1. Setup NGROK
  1. 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
  1. Setup for code
  • Clone the repository

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

    Run the bot from a terminal or from Visual Studio:

    A) From a terminal, navigate to samples/bot-all-cards/csharp/BotAllCards

    # run the bot
    dotnet run

    B) Or from Visual Studio

    • Launch Visual Studio
    • File -> Open -> Project/Solution
    • Navigate to samples/bot-all-cards/csharp/BotAllCards folder
    • Select BotAllCards.csproj file
    • Press F5 to run the project
  • This step is specific to Teams.

  1. Modify the manifest.json in the /appPackage folder and replace the following details:
  • {{Microsoft-App-Id}} with Application id generated from Step 1
  • {{domain-name}} with base Url domain. E.g. if you are using ngrok it would be 1234.ngrok-free.app and if you are using dev tunnels then your domain will be 12345.devtunnels.ms.
  1. Zip the contents of appPackage folder into a manifest.zip.

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

  • {{Microsoft-App-Id}} - Generated from Step 1 is the application app id
  • {{ Microsoft-App-Password}} - Generated from Step 1, also referred to as Client secret
  • {{ Microsoft-App-TenantId }} - Generated from Step 1 is the tenantId id
  • {{ ConnectionName }} - ConnectionName (OAuth Connection Name)

Bot OAuth Connection:

Installapp

Note:

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

Running the sample

Install App:

Installapp

Welcome Cards:

WelcomeCards

All Cards:

AllCards

Adaptive Card:

AdaptiveCard

Add media url from sharepoint or onedrive to the text input to get media loaded to the adaptive card. For more information refer media elements in card.

AdaptiveCardMedia

AdaptiveCardMedia2

Hero Card:

HeroCard

OAuth Card:

OAuthCard

Signin Card:

SigninCard

Thumbnail Card:

ThumbnailCard

List Card:

ListCards

Collections Card:

CollectionsCards

Connector Card:

ConnectorCards

Deploy the bot to Azure

To learn more about deploying a bot to Azure, see Deploy your bot to Azure for a complete list of deployment instructions.

Further reading