nodejs

page_type	description	products	languages	extensions	urlFragment
sample	This sample app demonstrates how to enable and configure applications for Microsoft Teams meetings, utilizing the Live Share SDK to facilitate a shared meeting stage experience.	office-teams office office-365	nodejs	contentType createdDate samples 11/10/2021 17:35:46	officedev-microsoft-teams-samples-meetings-stage-view-nodejs

Meetings Stage View

This sample application Enables the configuration of shared meeting stages within Microsoft Teams, leveraging the Live Share SDK for real-time collaboration. It includes features like a meeting side panel and customizable themes, providing users with a dynamic experience during meetings. The demo manifest is available for testing in your Microsoft Teams client.

Included Features

• Meeting Stage
• Meeting SidePanel
• Live Share SDK
• RSC Permissions

Interact with app - Web

Interact with app - Mobile

Interaction with app theme

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

Realtime meeting stage view: Manifest

Prerequisites

• NodeJS
• dev tunnel or ngrok latest version or equivalent tunnelling solution
• 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.

This sample also shows how to share specific parts of your app to the meeting stage. For reference please check Share app content to stage API

• Live-share-sdk-overview

Setup

This capability is currently available in developer preview only.

1. Register a new application in the Microsoft Entra ID – App Registrations portal. 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

• 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

• Clone the repository

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

• In a terminal, navigate to samples/meetings-stage-view/nodejs

• Install modules

  npm install
  

• Run both solutions i.e. samples/meetings-stage-view/nodejs/ and samples/meetings-stage-view/nodejs/Clientapp

  npm start
  

Getting the App id for share to stage deeplink.

1. Navigate to Teams admin portal

2. Under Teams Apps section, select Manage apps.

3. Search the uploaded app and copy the App ID

4. Navigate to samples/samples/meetings-stage-view/nodejs/ClientApp/src/components/app-in-meeting.jsx

5. On line 74, replace <<App id>> with Id obtained in step 3.

6. Navigate to samples/samples/meetings-stage-view/nodejs/ClientApp/src/components/share-to-meeting.jsx

7. On line 25, replace <Application-Base-URL> with your application's base url whrre app is running. E.g. if you are using ngrok it would be something like https://1234.ngrok-free.app and if you are using dev tunnels, your URL will be like: https://12345.devtunnels.ms.

8. On line 26, replace <<Application-ID>> with Id obtained in step 3.

9. When the app is running, the home page will contain a share to teams button. Clicking it will share the page content directly to meeting. (Make sure the app's base url is added in manifest's valid domains section and app is published to store).

4. 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 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.
  • Zip up the contents of the appManifest folder to create a manifest.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.

Running the sample.

You can use this app by following the below steps: - Edit a meeting and select + icon at the top right corner.

• Default home page

• It will redirect to consent popup to share screen

• The page will be shared in meeting

• App in stage view.

• Sharing specific part of your app to the meeting stage.

NOTE: Currently Live Share SDK is not supported in mobiles.

IOS Meeting Side panel and stage view.

Android Meeting Side panel and stage view.

- Search for your app `App in meeting` and add it.

- Join the meeting and click on the app icon at the top
- This will open a sidepanel with `Share` icon at top to share the app for collaboration in stage view.

- You can now interact with the app.

• Add Details for collaboration.

• App in sidepanel.

• Sharing specific parts of app.

Interaction with App theme when Teams Theme changes.

Further reading

• Build apps for Teams meeting stage
• Build tabs for meeting
• Meeting stage view
• Enable Share to Meeting
• Deeplink to meeting share to stage
• Handle theme change