page_type | description | products | languages | extensions | urlFragment | ||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
sample |
Demonstrating feature where user can checkin with current location and view all previous checkins using bot. |
|
|
|
officedev-microsoft-teams-samples-app-checkin-location-csharp |
This sample shows feature where user can checkin with current location and view all previous checkins using bot.
Currently, Microsoft Teams support for get geolocation capability is only available for mobile clients
- Bots
- Adaptive Cards
- Task Modules
- Device Permission API (location)
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
-
.NET Core SDK version 6.0
determine dotnet version
dotnet --version
-
dev tunnel or ngrok (For local environment testing) latest version (any other tunneling software can also be used)
-
Teams Microsoft Teams is installed and you have an account
- Setup for Bot
-
Register a Microsoft Entra ID aap registration in Azure portal.
-
Also, register a bot with Azure Bot Service, following the instructions here.
-
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, 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
-
Modify the
/appsettings.json
and fill in the following details:{{Microsoft-App-Id}}
- Generated from Step 1 while doing Microsoft Entra ID app registration in Azure portal.{{ Microsoft-App-Password}}
- Generated from Step 1, also referred to as Client secret{{ Application Base Url }}
- Your application's base url. E.g. https://12345.ngrok-free.app if you are using ngrok and if you are using dev tunnels, your URL will be https://12345.devtunnels.ms.
-
Run the bot from a terminal or from Visual Studio:
A) From a terminal, navigate to
samples/app-checkin-location/csharp
# run the bot dotnet run
B) Or from Visual Studio
- Launch Visual Studio
- File -> Open -> Project/Solution
- Navigate to
AppCheckinLocation
folder - Select
AppCheckinLocation.csproj
file - Press
F5
to run the project
Note: If you are facing any issue in your app, please uncomment this line and put your debugger for local debug.
- Setup Manifest for Teams
-
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 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 themanifest.json
) - Edit the
manifest.json
forvalidDomains
and replace{{domain-name}}
with base Url of your domain. E.g. if you are using ngrok it would behttps://1234.ngrok-free.app
then your domain-name will be1234.ngrok-free.app
and if you are using dev tunnels then your domain will be like:12345.devtunnels.ms
. - Zip up the contents of the
AppManifest
folder to create amanifest.zip
(Make sure that zip file does not contains any subfolder otherwise you will get error while uploading your .zip package)
- Edit the
-
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 ./AppManifest folder, select the zip folder, and choose Open.
- Select Add in the pop-up dialog box. Your app is uploaded to Teams.
Card with actions check in:
Geo Location of user:
User details:
Viewcheckin Details of user:
Geo Location of user:
View Location UI:
To learn more about deploying a bot to Azure, see Deploy your bot to Azure for a complete list of deployment instructions.