Skip to content

Latest commit

 

History

History
 
 

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
page_type description products languages extensions urlFragment
sample
This sample feature shows how to improve the subsequent loading time of an App that the user has visited during the current meeting. The tab is loaded as an sidepanel in meeting.
office-teams
office
office-365
Nodejs
contentType createdDate
samples
11/11/2022 11:50:25 AM
officedev-microsoft-teams-samples-app-caching-in-meetings-nodejs

App Caching In Meetings

This sample feature shows how to improve the subsequent loading time of an App that the user has visited during the current meeting (Specifically Apps loaded in the side panel of a meeting).

Interaction with App App-Cache

Prerequisites

Setup

Note these instructions are for running the sample on your local machine.

  1. Run ngrok - point to port 3978

    ngrok http 3978 --host-header="localhost:3978"
  2. Clone the repository

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

    Open your project in Visual Studio Code (Optional Step)

    • Launch Visual Studio code
    • File -> Open Folder
    • Navigate to samples/app-cache-meetings folder
    • Select nodejs folder and open it

    Install node modules (Either open any local terminal inside your nodejs folder or open Visual Studio Code terminal by opening the project in Visual Studio Code)

    npm install
  3. Run your app (Either from any local terminal or from Visual Studio Code terminal)

    npm start
    • Your App will start running on 3978 PORT.
  4. This step is specific to Teams.

    • Edit the manifest.json contained in the appPackage folder to replace your <<MANIFEST-ID>>, You can use any GUID Id in place of <<Manifest-ID>> or Generate Guid
    • Edit the manifest.json for <<Valid_Domain>> with base Url 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. Replace it at all the places in your manifest.json.
    • 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 Teams Apps/Manage your apps click "Upload an app". Browse to and Open the .zip file. At the next dialog, click the Add button.)
    • Sideload the app In meetings (Supported scopes)

Running the sample

Add the App in meeting. Set-Up-Tab

App Caching Sideloaded : participant context

AppCache in first tab with Unique Id Loaded : Team Context

AppCache in second tab with Unique Id Loaded : Team Context

Note open debug panel Proto Task Manager ( Ctrl+Shift+Alt+8 on Windows, Cmd+Shift+Option+8 on Mac), navigate to App Caching section you should see these apps getting cached/loaded. Non-cacheable apps will not appear in this panel.

Further reading

Upload your app in Teams

Manage custom and sideloaded apps in Teams admin center