page_type | description | products | languages | extensions | urlFragment | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
sample |
Demonstrating the feature of people picker on Adaptive Cards using bot. |
|
|
|
officedev-microsoft-teams-samples-bot-people-picker-adaptive-card-nodejs |
This sample shows the feature of people picker on Adaptive Cards.
Use the bot command peoplepickercard
to get the card with people picker control
- Bots
- People Picker in Adaptive Card
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).
People picker control in Adaptive Cards: Manifest
-
dev tunnel or Ngrok (For local environment testing) latest version (any other tunneling software can also be used)
-
If you are using Ngrok To test locally, NodeJS must be installed on your development machine (latest version)
-
You'll need Ngrok installed on your development machine. Make sure you've downloaded and installed Ngrok on your local machine. ngrok will tunnel requests from the Internet to your local computer and terminate the SSL connection from Teams.
The simplest way to run this sample in Teams is to use Teams Toolkit for Visual Studio Code.
- Ensure you have downloaded and installed Visual Studio Code
- Install the Teams Toolkit extension
- Select File > Open Folder in VS Code and choose this samples directory from the repo
- Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps
- Select Debug > Start Debugging or F5 to run the app in a Teams web client.
- 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.
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.
- Setup for Bot
-
In Azure portal, create Microsoft Entra ID app registraion and it will generate MicrosoftAppId and MicrosoftAppPassword for you.
-
In Azure portal, create a Azure Bot resource.
-
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 in Azure portal, you will create an App ID and App password - make sure you keep these for later.
-
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
-
Setup for code
-
Clone the repository
git clone https://github.com/OfficeDev/Microsoft-Teams-Samples.git
-
In the folder where repository is cloned navigate to
samples/bot-people-picker-adaptive-card/nodejs
-
Install node modules
Inside node js folder, open your local terminal and run the below command to install node modules. You can do the same in Visual Studio code terminal by opening the project in Visual Studio code.
npm install
-
Open the
.env
configuration file in your project folder (or in Visual Studio Code) and update theMicrosoftAppId
andMicrosoftAppPassword
with the values generated while doing Microsoft Entra ID app registration including Secret creation.(ClientSecret is referred to as the "client secret" generated from your Microsoft Entra ID app registrationin. -
Run your app
npm start
-
Setup Manifest for Teams
- Edit the
manifest.json
contained in theappManifest/
folder to replace with your MicrosoftAppId (that was created in step 1 and is the same value of MicrosoftAppId in.env
file) everywhere you see the place holder string{{Microsoft-App-Id}}
(depending on the scenario the Microsoft App Id may occur multiple times in themanifest.json
). - Zip up the contents of the
appManifest/
folder to create amanifest.zip
- Upload the
manifest.zip
to Teams (in the left-bottom Apps view, click "Upload a custom app")
- Edit the
Note: If you are facing any issue in your app, please uncomment this line and put your debugger for local debug.
Peoplepickercard command interaction:
Personal scope get all the users of organisation:
Team or groupchat scope get user list to current context:
On Assign button click the bot will return the member id that we have selected:
To learn more about deploying a bot to Azure, see Deploy your bot to Azure for a complete list of deployment instructions.