nodejs

page_type	description	products	languages	extensions	urlFragment
sample	This sample showcases a Microsoft Teams bot that allows users to check in their current location and view all previous check-ins seamlessly.	office-teams office office-365	nodejs	contentType createdDate samples 11/11/2021 23:30:17 PM	officedev-microsoft-teams-samples-app-checkin-location-nodejs

Get Checkin info of user

The App Check-In Location sample demonstrates a feature that allows users to check in from their current location and view all previous check-ins using a bot. This functionality is particularly beneficial for tracking attendance and user engagement within the Microsoft Teams environment.

Currently, Microsoft Teams support for get geolocation capability is only available for mobile clients

Included Features

• Bots
• Adaptive Cards
• Task Modules
• Device Permission API (Location)

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

App check-in location: 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 16.14.2 or higher)
• dev tunnel or ngrok latest version or equivalent tunneling solution
• M365 developer account or access to a Teams account with the appropriate permissions to install an app.
• Teams Toolkit for VS Code or TeamsFx CLI

Run the app (Using Teams Toolkit for Visual Studio Code)

The simplest way to run this sample in Teams is to use Teams Toolkit for Visual Studio Code.

1. Ensure you have downloaded and installed Visual Studio Code
2. Install the Teams Toolkit extension
3. Select File > Open Folder in VS Code and choose this samples directory from the repo
4. Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps
5. Select Debug > Start Debugging or F5 to run the app in a Teams web client.
6. 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

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. 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_tunnel_domain>/api/messages as the messaging endpoint. NOTE: When you create app registration, you will create an App ID and App password - make sure you keep these for later.

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

3. Setup for code

1. Clone the repository

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

2. In a terminal, navigate to samples/app-checkin-location/nodejs

3. Install modules

   npm install

4. Update the .env configuration for the bot to use the MicrosoftAppId and MicrosoftAppPassword, BaseUrl with application base url. For e.g., your ngrok url. (Note the MicrosoftAppId is the AppId created in step 1 (Setup for Bot), 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.)

5. Run your app

   npm start

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

4. Setup Manifest for Teams

• This step is specific to Teams.
  • Edit the manifest.json contained in the appManifest/ folder to replace with your MicrosoftAppId (that was created in step1.1 and is the same value of MicrosoftAppId in .env file) everywhere you see the place holder string {MicrosoftAppId} (depending on the scenario the Microsoft App Id may occur multiple times in the manifest.json)
  • Zip up the contents of the appManifest/ folder to create a manifest.zip
  • Upload the manifest.zip to Teams (in the left-bottom Apps view, click "Upload a custom app")

Running the sample

Card with actions check in:

Geo Location of user:

User details:

Viewcheckin Details of user:

View Location UI:

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

• Bot Framework Documentation
• Bot Basics
• Azure Bot Service Introduction
• Azure Bot Service Documentation
• Integrate media Capabilities inside your app