README.md

page_type	description	products	languages	extensions	urlFragment
sample	Microsoft Teams sample which displays deeplinks for call, video, chat, navigate to app and navigate within tab pages which are supported for tab and bot.	office-teams office office-365	nodejs	contentType createdDate samples 07-07-2021 13:38:27	officedev-microsoft-teams-samples-tab-deeplink-nodejs

DeepLink

Microsoft Teams sample which displays deeplinks for call, video, chat, navigate to app and navigate within tab pages which are supported for tab and bot.DeepLink

Included Features

• Tabs
• Bots
• Deep Links

Interaction with app.

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

1. Register a new application in the Microsoft Entra ID – App Registrations portal.

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

3. Setup NGROK

• 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

4. Setup for code

• Clone the repository

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

• Update the .env configuration for the bot to use the YOUR-MICROSOFT-APP-ID, YOUR-MICROSOFT-APP-PASSWORD and BASE-URL is tunnel url eg. 124.ngrok-free.app. (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.)

  • In a terminal, navigate to samples/tab-deeplink/nodejs

    cd samples/tab-deeplink/nodejs

  • Install modules

    npm install

  • Navigate to env.js file and update your AppId at placeholder <<App-ID>> (You can get it manually frrm teams admin portal.

  • 

  • Start the bot

    npm start

  • If you are using Visual Studio code

  • Launch Visual Studio code

  • Folder -> Open -> Project/Solution

  • Navigate to samples/tab-deeplink/nodejs folder

  • Select nodejs Folder

  • To run the application required node modules.Please use this command to install modules npm i.

5. 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 <<YOUR-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 and if you are using dev tunnels then your domain will be like: 12345.devtunnels.ms. Note: If you want to test your app across multi hub like: Outlook/Office.com, please update the manifest.json in the tab-deeplink\nodejs\appManifest_Hub folder with the required values.
  • Zip up the contents of the appManifest folder to create a appManifest.zip or appManifest_Hub folder to create a appManifest_Hub.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 ./appManifest folder, select the zip folder, and choose Open.
  • Select Add in the pop-up dialog box. Your app is uploaded to Teams.

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

Interacting with the bot

Enter text in the emulator. The text will be echoed back by the bot.

1. Interact with DeepLink bot by pinging it in personal or channel scope.

2. Select the option from the options displayed in the adaptive card. This will redirect to the respective Task in the Tab.

3. Click on Back to List to view all the options and additional features of deep link using Microsoft teams SDK v2.0.0. User can select an option which will redirect to the respective Task in the Tab.

4. Add this application in live meeting and stage the content.

5. While it's in stage view, using same deeplink to open tab will open the meeting side panel tab.

6. Deeplink to meeting side panel:

@mention bot in meeting chat to get an adaptive card.

Click on Side Panel Deeplink which will redirect to the meeting side panel. Note: When the deeplink is opened outside meeting, it will redirect to meeting details tab.

Tab interaction:

Deeplink to Audio Call:

Deeplink to Video Call:

Deeplink to Meeting schedule:

Deeplink to Polly app install dialog:

Deeplink to start new chat:

Deeplink to channel conversation:

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.

On the side bar, select More Apps. Your sideloaded app title appears among your installed apps

Select your app icon to launch and preview your app running in Outlook on the web

Note: Similarly, you can test your application in the Outlook desktop app as well.

Office on the web

• To preview your app running in Office on the web.

• Log into office.com with test tenant credentials

Select the Apps icon on the side bar. Your sideloaded app title appears among your installed apps

Select your app icon to launch your app in Office on the web

Note: Similarly, you can test your application in the Office 365 desktop app as well.

Further reading

• Extend Teams apps across Microsoft 365