@microsoft/teams-js 2.8.0-beta.1 → 2.8.0

package/README.md

@@ -24,7 +24,7 @@ To install the stable [version](https://learn.microsoft.com/javascript/api/overv
 
 ### Production
 
-You can reference these files directly [from here](https://res.cdn.office.net/teams-js/2.7.1/js/MicrosoftTeams.min.js) or point your package manager at them.
+You can reference these files directly [from here](https://res.cdn.office.net/teams-js/2.8.0/js/MicrosoftTeams.min.js) or point your package manager at them.
 
 ## Usage
 
@@ -45,13 +45,13 @@ Reference the library inside of your `.html` page using:
 ```html
 <!-- Microsoft Teams JavaScript API (via CDN) -->
 <script
-  src="https://res.cdn.office.net/teams-js/2.7.1/js/MicrosoftTeams.min.js"
-  integrity="sha384-4Gy2G+qxzDVdrdemcVqKVQvaSK1Ghg3x6xcsaMLPc/pw7KPtiogHGM97LTWF2PWg"
+  src="https://res.cdn.office.net/teams-js/2.8.0/js/MicrosoftTeams.min.js"
+  integrity="sha384-/DJ9oJEFZSpGiUQx9Na5Yb5svOPPqSb3khKxJ/YgoZ2GtrkzWgSTBpESy3LvMPVk"
   crossorigin="anonymous"
 ></script>
 
 <!-- Microsoft Teams JavaScript API (via npm) -->
-<script src="node_modules/@microsoft/teams-js@2.7.1/dist/MicrosoftTeams.min.js"></script>
+<script src="node_modules/@microsoft/teams-js@2.8.0/dist/MicrosoftTeams.min.js"></script>
 
 <!-- Microsoft Teams JavaScript API (via local) -->
 <script src="MicrosoftTeams.min.js"></script>

package/dist/MicrosoftTeams.d.ts

@@ -3435,19 +3435,15 @@ export interface DialogSize {
         width: DialogDimension | number;
 }
 /**
-    * @hidden
-    *
-    * @internal
-    * Limited to Microsoft-internal use
+    * @beta
+    * Data structure to be used with the {@link teamsCore.registerOnLoadHandler teamsCore.registerOnLoadHandler(handler: (context: LoadContext) => void): void} to pass the context to the app.
     */
 export interface LoadContext {
         /**
-            * @hidden
             * The entity that is requested to be loaded
             */
         entityId: string;
         /**
-            * @hidden
             * The content URL that is requested to be loaded
             */
         contentUrl: string;
@@ -6362,12 +6358,14 @@ export namespace teamsCore {
             */
         function print(): void;
         /**
-            * @hidden
             * Registers a handler to be called when the page has been requested to load.
             *
+            * @remarks Check out [App Caching in Teams](https://learn.microsoft.com/microsoftteams/platform/apps-in-teams-meetings/build-tabs-for-meeting?tabs=desktop%2Cmeeting-chat-view-desktop%2Cmeeting-stage-view-desktop%2Cchannel-meeting-desktop#app-caching)
+            * for a more detailed explanation about using this API.
+            *
             * @param handler - The handler to invoke when the page is loaded.
             *
-            * @internal
+            * @beta
             */
         function registerOnLoadHandler(handler: (context: LoadContext) => void): void;
         /**
@@ -6382,13 +6380,15 @@ export namespace teamsCore {
             */
         function registerOnLoadHandlerHelper(handler: (context: LoadContext) => void, versionSpecificHelper?: () => void): void;
         /**
-            * @hidden
             * Registers a handler to be called before the page is unloaded.
             *
+            * @remarks Check out [App Caching in Teams](https://learn.microsoft.com/microsoftteams/platform/apps-in-teams-meetings/build-tabs-for-meeting?tabs=desktop%2Cmeeting-chat-view-desktop%2Cmeeting-stage-view-desktop%2Cchannel-meeting-desktop#app-caching)
+            * for a more detailed explanation about using this API.
+            *
             * @param handler - The handler to invoke before the page is unloaded. If this handler returns true the page should
             * invoke the readyToUnload function provided to it once it's ready to be unloaded.
             *
-            * @internal
+            * @beta
             */
         function registerBeforeUnloadHandler(handler: (readyToUnload: () => void) => boolean): void;
         /**

package/dist/MicrosoftTeams.js

@@ -2151,7 +2151,7 @@ var _minRuntimeConfigToUninitialize = {
 };
 
 ;// CONCATENATED MODULE: ./src/public/version.ts
-var version = "2.8.0-beta.1";
+var version = "2.8.0";
 
 ;// CONCATENATED MODULE: ./src/internal/internalAPIs.ts
 
@@ -3358,12 +3358,14 @@ var teamsCore;
     }
     teamsCore.print = print;
     /**
-     * @hidden
      * Registers a handler to be called when the page has been requested to load.
      *
+     * @remarks Check out [App Caching in Teams](https://learn.microsoft.com/microsoftteams/platform/apps-in-teams-meetings/build-tabs-for-meeting?tabs=desktop%2Cmeeting-chat-view-desktop%2Cmeeting-stage-view-desktop%2Cchannel-meeting-desktop#app-caching)
+     * for a more detailed explanation about using this API.
+     *
      * @param handler - The handler to invoke when the page is loaded.
      *
-     * @internal
+     * @beta
      */
     function registerOnLoadHandler(handler) {
         registerOnLoadHandlerHelper(handler, function () {
@@ -3393,13 +3395,15 @@ var teamsCore;
     }
     teamsCore.registerOnLoadHandlerHelper = registerOnLoadHandlerHelper;
     /**
-     * @hidden
      * Registers a handler to be called before the page is unloaded.
      *
+     * @remarks Check out [App Caching in Teams](https://learn.microsoft.com/microsoftteams/platform/apps-in-teams-meetings/build-tabs-for-meeting?tabs=desktop%2Cmeeting-chat-view-desktop%2Cmeeting-stage-view-desktop%2Cchannel-meeting-desktop#app-caching)
+     * for a more detailed explanation about using this API.
+     *
      * @param handler - The handler to invoke before the page is unloaded. If this handler returns true the page should
      * invoke the readyToUnload function provided to it once it's ready to be unloaded.
      *
-     * @internal
+     * @beta
      */
     function registerBeforeUnloadHandler(handler) {
         registerBeforeUnloadHandlerHelper(handler, function () {