Skip to content

Latest commit

 

History

History
 
 
page_type description products languages extensions
sample
Microsoft Teams meeting extensibility sample - token passing
office-teams
office
office-365
nodejs
contentType createdDate
samples
07-07-2021 13:38:27

Meeting Token Generator

The Meeting Token Generator app is a sample Microsoft Teams app that extends meetings in Teams. Through this app, meeting participants can request a "token", which is generated sequentially so that each participant has a fair opportunity to interact. This can be useful in situations like scrum meetings, Q&A sessions, etc.

Key features

  • Display the current token that is being serviced in the meeting
  • Display the user list sorted by the token number in ascending order
  • Generate a token for the user upon request
  • Display the current user's token number
  • Mark a token as done by the user
  • Skip the current token for the organizer of the meeting

config_page

pre_meeting_tab

side_panel_tab

Prerequisites

Tools

  • .NET Core SDK version 3.1

    # determine dotnet version
    dotnet --version
  • Nodejs version 10.21.0+ (use the LTS version)

    # determine dotnet version
    node --version
  • Ngrok (Only for devbox testing) Latest (any other tunneling software can also be used)

    # run ngrok locally
    ngrok http -host-header=rewrite 3978

Technologies

We assume working knowledge of the following technologies to gain full understanding of the app

The app uses the Teams extensibility features described on the following pages:

Running the sample

Step 1: Register Azure AD applications

  1. Start an ngrok session as indicated above. Note the ngrok domain, as you will use this in the registration steps below, where it will be the value of WebAppDomain.
  2. Register your bot using bot channel registration in Azure AD portal, following the instructions here.
  1. Update the AAD app registration for tab SSO, following the instructions here. The "fully qualified domain name" in the instructions will be your ngrok domain.
  2. Set up the .env with the following keys:
    • "BotId" : Application (Bot) ID of the bot's Azure AD application
    • "BotPassword" : client secret of the bot's Azure AD application
    • "clientId" : Application (client) ID of the bot's Azure AD application
    • "clientSecret" : client secret of the Azure AD application
    • "baseUrl" : Base URI of the Application

If your Bot and Azure Application are same then the 'BotId' & 'clientId' will be same and 'BotPassword' & 'clientSecret' will be same

Step 2: Add the following entry to the manifest.json (schema reference)

  1. Add your bot configuration, with the app id of the bot generated from the previous steps
  2. Fill-in the following webApplicationInfo section, using MicrosoftAppId and WebAppDomain values from the previous section.
    "webApplicationInfo": {  
      "id": "[MicrosoftAppId]",  
      "resource": "api://[WebAppDomainName]/[MicrosoftAppId]"  
    }

Step 3: Run Ngrok

  1. The application (client) will run on port 4000
  2. ngrok http -host-header=rewrite 4000

Step 4: Run Client & the Server

You can build and run the project from the command line or an IDE:

  1. Navigate to the Project root folder
  2. Build Client
    • Open terminal
    • npm run build
  3. Run Client
    • Open new terminal
    • npm run client
    • The client will start running on 4000 port
  4. Run Server
    • Open new terminal
    • npm run server
    • The server will start running on 3978 port
  5. Update the manifest .zip file under appPackage folder
    • npm run manifest
  6. Now your application is running and ready to upload

Step 5: Enable developer preview in your desktop Teams client

Follow these instructions to enable developer preview. Note that Developer preview mode must be enabled on each Teams client app or browser.

In-meeting tabs are only available in the Teams desktop client. They will not be visible when you run Teams in a web browser.

Step 6: Sideload the app in a Teams desktop client

  1. Create a .zip using the below files, which are in the appPackage folder.
  • manifest.json
  • icon-outline.png
  • icon-color.png
  1. Create a meeting with few test participants, ideally with a mix of Presenters and Attendees.
  2. Once meeting is created, go to the meeting details page and click on the "Add tab" (+) button.
  3. In the pop-up that opens, click on "Manage apps".
  4. Click on "Upload a custom app" and upload the .zip file that was created in the previous steps. This adds the app to the meeting.
  5. Click on the "Add tab" button again. Now in the app selection page, the app should be visible as a "Meeting optimized tab".
  6. Select the Meeting Token app.
  7. Now the app will be visible in the meeting chat.
  8. Start the meeting and the icon should be visible in the meeting control bar.

User interactions

  • Token - Requests a token for the user
  • Done - Acknowledges that the user is done with the token
  • Skip - Skips the current user and moves on to the next person in line for a token. This button is only shown to users with the meeting Organizer role.

Troubleshooting

The sample app uses an in-memory store to maintain token information and the service URL for the tenant. If you restart the project, you must run the following command to recapture the service URL: @[BotName] reset

In your own projects, please use a durable storage mechanism to store the service URL for the tenant.

Further reading

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.