Microsoft-Teams-Samples/samples/bot-formatting-cards/nodejs at main · thisiskeithkwan/Microsoft-Teams-Samples

History

Name		Name	Last commit message	Last commit date
parent directory ..
Images		Images
appPackage		appPackage
assets		assets
bots		bots
demo-manifest		demo-manifest
resources		resources
.env		.env
.gitignore		.gitignore
Readme.md		Readme.md
index.js		index.js
package-lock.json		package-lock.json
package.json		package.json

Readme.md

page_type

description

products

languages

extensions

urlFragment

sample

Sample which demonstrates different formatting supported in cards using bot.

office-teams

office

office-365

nodejs

contentType	createdDate
samples	01/28/2023 05:00:17 PM

officedev-microsoft-teams-samples-bot-formatting-cards-nodejs

Different Formatting Cards

This sample shows the feature where user can use different formatting on adaptive cards using bot.

Included Features

Bots
Adaptive Cards

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

Send different formatting on cards: Manifest

Prerequisites

Microsoft Teams is installed and you have an account (not a guest account).
To test locally, NodeJS must be installed on your development machine (version 18x or higher).
ngrok or equivalent tunneling solution.

Setup

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.

Register a new application in the Azure Active Directory – App Registrations portal.
Setup for Bot

In Azure portal, create a Azure Bot resource.
Ensure that you've enabled the Teams Channel
While registering the bot, use https://<your_ngrok_url>/api/messages as the messaging endpoint.

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

Setup NGROK
Run ngrok - point to port 3978

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

Setup for code

Clone the repository

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

In a terminal, navigate to samples/bot-formatting-cards/nodejs
Update the .env configuration file and replace with placeholder {{Microsoft-App-Id}} and {{Microsoft-App-Password}}. (Note the MicrosoftAppId is the AppId created in step 1 (Setup AAD app registration in your Azure portal), the MicrosoftAppPassword is referred to as the "client secret" in step 1 (Setup for Bot) and you can always create a new client secret anytime.)

Update mentionSupport json

Bots support user mention with the Azure AD Object ID and UPN, in addition to the existing IDs. The support for two new IDs is available in bots for text messages, Adaptive Cards body, and message extension response. Bots support the mention IDs in conversation and invoke scenarios. The user gets activity feed notification when being @mentioned with the IDs.
- Navigate to samples\bot-formatting-cards\nodejs\resources\mentionSupport.json
  1. On line 14, replace {{new-Ids}}
  2. On line 23, replace {{Email-Id}}
  3. On line 31, replace {{Microsoft-App-Id}}
  - E.g.
```
"text": "Hi <at>Adele UPN</at>, <at>Adele Azure AD</at>"
    }
],
"msteams": {
    "entities": [
    {
        "type": "mention",
        "text": "<at>Adele UPN</at>",
        "mentioned": {
        "id": "[email protected]",
        "name": "Adele Vance"
        }
    },
    {
        "type": "mention",
        "text": "<at>Adele Azure AD</at>",
        "mentioned": {
        "id": "87d349ed-44d7-43e1-9a83-5f2406dee5bd",
        "name": "Adele Vance"
        }
    }
    ]
```

In index.js file at line number 40, uncomment commented line for local debugging.

Install modules
```
npm install
```
Run your app
```
npm start
```

Setup Manifest for Teams

This step is specific to Teams.
- Edit the manifest.json contained in the ./appPackage folder to replace your MicrosoftAppId (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.
- 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.