Skip to content

Latest commit

 

History

History
 
 
page_type description products languages extensions urlFragment
sample
This sample shows messaging extension with adaptive card-based loop components functionality.
office-teams
office
office-365
csharp
contentType createdDate
samples
09-20-2023 20:32:25
officedev-microsoft-teams-samples-msgext-unfurling-ac-loop-components-csharp

Messaging Extension with Adaptive Card Loop Components

If you copy and paste a link from https://github.com/OfficeDev/Microsoft-Teams-Samples/tree/main or your ngrok base url, it wil unfurl inside compose area.

Included Features

  • Message Extensions
  • Search Commands
  • Link Unfurling
  • Adaptive card based loop component

Interaction with teams

msgext-unfurling-ac-loop-components

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

Msgext-Unfurling-Adaptive-Card-Loop-Components: Manifest

Prerequisites

  • Microsoft Teams is installed and you have an account
  • .NET SDK version 6.0
  • dev tunnel or ngrok latest version or equivalent tunnelling solution

Run the sample locally

1. Register you app with Azure AD

  1. Register a new application in the Microsoft Entra ID – App Registrations portal.
  2. 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.
  3. 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.
  4. 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.

2. Setup

  1. Setup for Bot

    In Azure portal, create a Azure Bot resource.

    • For bot handle, make up a name.
    • Select "Use existing app registration" (Create the app registration in Microsoft Entra ID beforehand.)
    • If you don't have an Azure account create an Azure free account here

    In the new Azure Bot resource in the Portal,

Note these instructions are for running the sample on your local machine, the tunnelling solution is required because the Teams service needs to call into the bot.

  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

3. Setup for code

  1. Clone the repository

    git clone https://github.com/OfficeDev/Microsoft-Teams-Samples.git
  2. If you are using Visual Studio

    • Launch Visual Studio
    • File -> Open -> Project/Solution
    • Navigate to samples/msgext-unfurling-ac-loop-components/csharp folder
    • Select MsgextUnfurlingAcLoop.csproj or MsgextUnfurlingAcLoop.slnfile
  3. Modify the /appsettings.json and fill in the following details:

  • {{Microsoft-App-Type}} - (Allowed values are: MultiTenant(default), SingleTenant, UserAssignedMSI)
  • {{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
  1. Run your bot, either from Visual Studio with F5 or using dotnet run in the appropriate folder.

  2. This step is specific to Teams.

    • Edit the manifest.json contained in the AppManifest folder to replace your Microsoft App Id (that was created when you registered your bot 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 {{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.
    • Zip up the contents of the AppManifest 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 Teams Apps/Manage your apps click "Upload an app". Browse to and Open the .zip file. At the next dialog, click the Add button.)

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

4. Running the sample

Note the Teams manifest.json for this sample also includes a Search Query. This Messaging Extension is only introduced in order to enable installation, because there is no mechanism for installing a link unfurling feature in isolation.

Install App: 1.InstallApp

Add to a chat: 2.SelectAddToChat

Add to a group chat: 3.GroupChat

If you copy and paste a link from https://github.com/OfficeDev/Microsoft-Teams-Samples/tree/main into the compose message area the link will unfurl: 4.AdaptiveCardLoopComponent

Search for actions and apps: 5.SelectACloopComponent

Search: 6.MsgextSearch

Search Results: 7.MsgextSearchResults

Adaptive Card Based Loop Components: 8.AdaptiveCardLoopComponentMsgextSearch

Click Execute: 9.ClickExecute

Successfully Execute: 10.SuccessfullyExecute

Outlook on the web

  • To view your app in Outlook on the web.

  • Go to Outlook on the weband sign in using your dev tenant account.

After opening Outlook web, click the "New mail" button: 1.OutlookClickmail

On the tool bar on top,select Apps icon. Your sideloaded app title appears among your installed apps: 2.OutlookOpenApp

Select your app icon: 3.OutlookSelectApp

Search for actions and apps: 4.OutlookMsgext

Search Results: 5.OutlookSearchCard

Adaptive Card Based Loop Components: 6.OutlookClickCard

Click Execute: 7.OutlookClickEx

Successfully Execute: 8.OutlookOutput

If you copy and paste a link from https://github.com/OfficeDev/Microsoft-Teams-Samples/tree/main into the compose message area the link will unfurl: 9.OutlookAClink

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