Skip to content

Latest commit

 

History

History
 
 

nodejs

Readme.md

page_type description products languages extensions contentType createdDate
sample
Microsoft Teams tab sample app for demonstrating create conversation tab
office-teams
office
office-365
nodejs
samples
06-10-2021 01:48:56

Conversational Tabs

This Teams tab app provides a way to allow users to have conversations about sub-entities in the tab Create conversational tabs

Key features

  • Tab showing actions that can be performed

Actions Page

  • Open Conversation - opens a new conversation

Open Conversation

  • Close Conversation - closes the conversation view

Close Conversation

  • Continue Conversation - continues old conversation based on conversation id

Continue Conversation

NOTE: We should save the subEntityId and conversationId to continue an existing conversartion.

  • Deeplink to Conversation - opens the conversation in channel

Deeplink to Conversation

Prerequisites

  1. Office 365 tenant. You can get a free tenant for development use by signing up for the Office 365 Developer Program.

  2. To test locally, NodeJS must be installed on your development machine (version 10.14 or higher).

    # determine node version
node --version

  3. To test locally, 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.

NOTE: The free ngrok plan will generate a new URL every time you run it, which requires you to update your Azure AD registration, the Teams app manifest, and the project configuration. A paid account with a permanent ngrok URL is recommended.

To try this sample

  • Clone the repository

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

  • In a console, navigate to samples/tab-conversations/nodejs

    cd samples/tab-conversations/nodejs

  • Run ngrok - point to port 3978

    ngrok http -host-header=localhost 3978

  • Install modules & Run the NodeJS Server

    • Server will run on PORT: 3978
    • Open a terminal and navigate to project root directory
    npm run server

    This command is equivalent to: npm install > npm start

  • This step is specific to Teams.

    • Edit the manifest.json contained in the appPackage folder to replace <<your base url>> with your ngrok url or hosted app url and also update the <<DOMAIN-NAME>> for allowed domains.
    • Zip up the contents of the appPackage folder to create a manifest.zip
    • 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 tab is uploaded to Teams.

Interacting with the tab in Teams

You can use this tab by following the below steps:

  • In the navigation bar located at the far left in Teams, select the ellipses ●●● and choose your app from the list.

Further reading