README.md

page_type	description	products	languages	extensions	urlFragment
sample	This sample app demonstrates how to enable and configure applications for Microsoft Teams meetings, allowing users to interact with a shared meeting stage using the Live Share SDK.	office-teams office office-365	csharp	contentType createdDate samples 21/10/2022 19:03:46	officedev-microsoft-teams-samples-meetings-stage-view-csharp

Meetings Stage View

This sample application enables the configuration and use of shared meeting stages within Microsoft Teams, leveraging the Live Share SDK for real-time interaction. It includes features such as a meeting side panel and theme customization options, allowing users to enhance their collaborative 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

Interaction with app - Web

Interaction 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 manifest (.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

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

-Teams Toolkit for Visual Studio

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

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

1.Install Visual Studio 2022 Version 17.10 Preview 4 or higher Visual Studio 2.Install Teams Toolkit for Visual Studio Teams Toolkit extension 3.In the debug dropdown menu of Visual Studio, select Dev Tunnels > Create A Tunnel (set authentication type to Public) or select an existing public dev tunnel. 4.In the debug dropdown menu of Visual Studio, select default startup project > Microsoft Teams (browser) 5.In Visual Studio, right-click your TeamsApp project and Select Teams Toolkit > Prepare Teams App Dependencies 6.Using the extension, sign in with your Microsoft 365 account where you have permissions to upload custom apps. 7.Select Debug > Start Debugging or F5 to run the menu in Visual Studio. 8.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.

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 your 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/csharp

  # change into project folder
  cd # AppInMeeting

• Inside ClientApp folder execute the below command.

  # npx @fluidframework/azure-local-service@latest

• Run the app from a terminal or from Visual Studio, choose option A or B.

  A) From a terminal

  # run the app
  dotnet run

  B) Or from Visual Studio

  • Launch Visual Studio
  • File -> Open -> Project/Solution
  • Navigate to AppInMeeting folder
  • Select AppInMeeting.csproj file
  • Press F5 to run the project

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/meetings-stage-view/csharp/AppInMeeting/ClientApp/src/components/app-in-meeting.jsx

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

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

7. On line 24, 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 25, 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).

5. Setup Manifest for Teams

• This step is specific to Teams.

  • Edit the manifest.json contained in the ./appPackage 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 appPackage 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 ./appPackage 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.

Android 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