@microsoft/teams-js 2.15.0 → 2.16.0-beta.1

package/dist/MicrosoftTeams.d.ts

@@ -2705,6 +2705,10 @@ export enum HostName {
             * Microsoft-internal test Host
             */
         orange = "Orange",
+        /**
+            * Microsoft connected workplace platform
+            */
+        places = "Places",
         /**
             * Teams
             */
@@ -3626,9 +3630,9 @@ export interface DialogInfo {
 export type TaskInfo = DialogInfo;
 /**
     * @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.
+    * Data structure to be used with the {@link app.lifecycle.registerOnResumeHandler app.lifecycle.registerOnResumeHandler(handler: (context: ResumeContext) => void): void} to pass the context to the app.
     */
-export interface LoadContext {
+export interface ResumeContext {
         /**
             * The entity that is requested to be loaded
             */
@@ -3638,6 +3642,11 @@ export interface LoadContext {
             */
         contentUrl: string;
 }
+/**
+    * @deprecated
+    * As of 2.14.1, please use ResumeContext instead.
+    */
+export type LoadContext = ResumeContext;
 /** Represents information about a frame within a tab or dialog module. */
 export interface FrameInfo {
         /**
@@ -4281,6 +4290,56 @@ export namespace app {
             * @returns Promise that will be fulfilled when the operation has completed
             */
         export function openLink(deepLink: string): Promise<void>;
+        /**
+            * A namespace for enabling the suspension or delayed termination of an app when the user navigates away.
+            * When an app registers for the registerBeforeSuspendOrTerminateHandler, it chooses to delay termination.
+            * When an app registers for both registerBeforeSuspendOrTerminateHandler and registerOnResumeHandler, it chooses the suspension of the app .
+            * Please note that selecting suspension doesn't guarantee prevention of background termination.
+            * The outcome is influenced by factors such as available memory and the number of suspended apps.
+            *
+            * @beta
+            */
+        export namespace lifecycle {
+                /**
+                    * Register on resume handler function type
+                    *
+                    * @param context - Data structure to be used to pass the context to the app.
+                    */
+                type registerOnResumeHandlerFunctionType = (context: ResumeContext) => void;
+                /**
+                    * Register before suspendOrTerminate handler function type
+                    *
+                    * @returns void
+                    */
+                type registerBeforeSuspendOrTerminateHandlerFunctionType = () => void;
+                /**
+                    * Registers a handler to be called before the page is suspended or terminated. Once a user navigates away from an app,
+                    * the handler will be invoked. App developers can use this handler to save unsaved data, pause sync calls etc.
+                    *
+                    * @param handler - The handler to invoke before the page is suspended or terminated. When invoked, app can perform tasks like cleanups, logging etc.
+                    * Upon returning, the app will be suspended or terminated.
+                    *
+                    */
+                export function registerBeforeSuspendOrTerminateHandler(handler: registerBeforeSuspendOrTerminateHandlerFunctionType): void;
+                /**
+                    * Registers a handler to be called when the page has been requested to resume from being suspended.
+                    *
+                    * @param handler - The handler to invoke when the page is requested to be resumed. The app is supposed to navigate to
+                    * the appropriate page using the ResumeContext. Once done, the app should then call {@link notifySuccess}.
+                    *
+                    * @beta
+                    */
+                export function registerOnResumeHandler(handler: registerOnResumeHandlerFunctionType): void;
+                /**
+                    * Checks if app.lifecycle is supported by the host.
+                    * @returns boolean to represent whether the lifecycle capability is supported
+                    * @throws Error if {@linkcode app.initialize} has not successfully completed
+                    *
+                    * @beta
+                    */
+                export function isSupported(): boolean;
+                export {};
+        }
         export {};
 }
 
@@ -6873,6 +6932,9 @@ export namespace teamsCore {
             *
             * @param handler - The handler to invoke when the page is loaded.
             *
+            * @deprecated
+            * As of 2.14.1, please use {@link app.lifecycle.registerOnResumeHandler} instead.
+            *
             * @beta
             */
         export function registerOnLoadHandler(handler: registerOnLoadHandlerFunctionType): void;
@@ -6885,6 +6947,8 @@ export namespace teamsCore {
             *
             * @param handler - The handler to invoke when the page is loaded.
             * @param versionSpecificHelper - The helper function containing logic pertaining to a specific version of the API.
+            *
+            * @deprecated
             */
         export function registerOnLoadHandlerHelper(handler: registerOnLoadHandlerFunctionType, versionSpecificHelper?: () => void): void;
         /**
@@ -6896,6 +6960,7 @@ export namespace teamsCore {
             * @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.
             *
+            * @deprecated
             * @beta
             */
         export function registerBeforeUnloadHandler(handler: registerBeforeUnloadHandlerFunctionType): void;
@@ -6909,6 +6974,8 @@ export namespace teamsCore {
             * @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.
             * @param versionSpecificHelper - The helper function containing logic pertaining to a specific version of the API.
+            *
+            * @deprecated
             */
         export function registerBeforeUnloadHandlerHelper(handler: registerBeforeUnloadHandlerFunctionType, versionSpecificHelper?: () => void): void;
         /**

package/dist/MicrosoftTeams.js

@@ -1351,6 +1351,10 @@ var HostName;
      * Microsoft-internal test Host
      */
     HostName["orange"] = "Orange";
+    /**
+     * Microsoft connected workplace platform
+     */
+    HostName["places"] = "Places";
     /**
      * Teams
      */
@@ -1972,6 +1976,11 @@ var teamsRuntimeConfig = {
     hostVersionsInfo: teamsMinAdaptiveCardVersion,
     isLegacyTeams: true,
     supports: {
+        app: {
+            lifecycle: {
+                caching: {},
+            },
+        },
         appInstallDialog: {},
         appEntity: {},
         call: {},
@@ -2203,7 +2212,7 @@ var _minRuntimeConfigToUninitialize = {
  * @hidden
  *  Package version.
  */
-var version = "2.15.0";
+var version = "2.16.0-beta.1";
 
 ;// CONCATENATED MODULE: ./src/internal/internalAPIs.ts
 
@@ -3354,137 +3363,6 @@ var menus;
     menus.isSupported = isSupported;
 })(menus || (menus = {}));
 
-;// CONCATENATED MODULE: ./src/public/teamsAPIs.ts
-
- // Conflict with some names
-
-
-
-
-/**
- * Namespace containing the set of APIs that support Teams-specific functionalities.
- */
-var teamsCore;
-(function (teamsCore) {
-    /**
-     * Enable print capability to support printing page using Ctrl+P and cmd+P
-     */
-    function enablePrintCapability() {
-        if (!GlobalVars.printCapabilityEnabled) {
-            ensureInitialized(runtime);
-            if (!isSupported()) {
-                throw errorNotSupportedOnPlatform;
-            }
-            GlobalVars.printCapabilityEnabled = true;
-            // adding ctrl+P and cmd+P handler
-            document.addEventListener('keydown', function (event) {
-                if ((event.ctrlKey || event.metaKey) && event.keyCode === 80) {
-                    print();
-                    event.cancelBubble = true;
-                    event.preventDefault();
-                    event.stopImmediatePropagation();
-                }
-            });
-        }
-    }
-    teamsCore.enablePrintCapability = enablePrintCapability;
-    /**
-     * default print handler
-     */
-    function print() {
-        ssrSafeWindow().print();
-    }
-    teamsCore.print = print;
-    /**
-     * 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.
-     *
-     * @beta
-     */
-    function registerOnLoadHandler(handler) {
-        registerOnLoadHandlerHelper(handler, function () {
-            if (handler && !isSupported()) {
-                throw errorNotSupportedOnPlatform;
-            }
-        });
-    }
-    teamsCore.registerOnLoadHandler = registerOnLoadHandler;
-    /**
-     * @hidden
-     * Undocumented helper function with shared code between deprecated version and current version of the registerOnLoadHandler API.
-     *
-     * @internal
-     * Limited to Microsoft-internal use
-     *
-     * @param handler - The handler to invoke when the page is loaded.
-     * @param versionSpecificHelper - The helper function containing logic pertaining to a specific version of the API.
-     */
-    function registerOnLoadHandlerHelper(handler, versionSpecificHelper) {
-        // allow for registration cleanup even when not finished initializing
-        handler && ensureInitialized(runtime);
-        if (handler && versionSpecificHelper) {
-            versionSpecificHelper();
-        }
-        handlers_registerOnLoadHandler(handler);
-    }
-    teamsCore.registerOnLoadHandlerHelper = registerOnLoadHandlerHelper;
-    /**
-     * 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.
-     *
-     * @beta
-     */
-    function registerBeforeUnloadHandler(handler) {
-        registerBeforeUnloadHandlerHelper(handler, function () {
-            if (handler && !isSupported()) {
-                throw errorNotSupportedOnPlatform;
-            }
-        });
-    }
-    teamsCore.registerBeforeUnloadHandler = registerBeforeUnloadHandler;
-    /**
-     * @hidden
-     * Undocumented helper function with shared code between deprecated version and current version of the registerBeforeUnloadHandler API.
-     *
-     * @internal
-     * Limited to Microsoft-internal use
-     *
-     * @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.
-     * @param versionSpecificHelper - The helper function containing logic pertaining to a specific version of the API.
-     */
-    function registerBeforeUnloadHandlerHelper(handler, versionSpecificHelper) {
-        // allow for registration cleanup even when not finished initializing
-        handler && ensureInitialized(runtime);
-        if (handler && versionSpecificHelper) {
-            versionSpecificHelper();
-        }
-        handlers_registerBeforeUnloadHandler(handler);
-    }
-    teamsCore.registerBeforeUnloadHandlerHelper = registerBeforeUnloadHandlerHelper;
-    /**
-     * Checks if teamsCore capability is supported by the host
-     *
-     * @returns boolean to represent whether the teamsCore capability is supported
-     *
-     * @throws Error if {@linkcode app.initialize} has not successfully completed
-     *
-     */
-    function isSupported() {
-        return ensureInitialized(runtime) && runtime.supports.teamsCore ? true : false;
-    }
-    teamsCore.isSupported = isSupported;
-})(teamsCore || (teamsCore = {}));
-
 ;// CONCATENATED MODULE: ./src/public/app.ts
 /* eslint-disable @typescript-eslint/no-empty-function */
 /* eslint-disable @typescript-eslint/explicit-module-boundary-types */
@@ -3503,8 +3381,6 @@ var teamsCore;
 
 
 
-
-
 /**
  * Namespace to interact with app initialization and lifecycle.
  */
@@ -3713,24 +3589,7 @@ var app;
         if (!GlobalVars.initializeCalled) {
             return;
         }
-        if (GlobalVars.frameContext) {
-            /* eslint-disable strict-null-checks/all */ /* Fix tracked by 5730662 */
-            registerOnThemeChangeHandler(null);
-            pages.backStack.registerBackButtonHandler(null);
-            pages.registerFullScreenHandler(null);
-            teamsCore.registerBeforeUnloadHandler(null);
-            teamsCore.registerOnLoadHandler(null);
-            logs.registerGetLogHandler(null); /* Fix tracked by 5730662 */
-            /* eslint-enable strict-null-checks/all */
-        }
-        if (GlobalVars.frameContext === FrameContexts.settings) {
-            /* eslint-disable-next-line strict-null-checks/all */ /* Fix tracked by 5730662 */
-            pages.config.registerOnSaveHandler(null);
-        }
-        if (GlobalVars.frameContext === FrameContexts.remove) {
-            /* eslint-disable-next-line strict-null-checks/all */ /* Fix tracked by 5730662 */
-            pages.config.registerOnRemoveHandler(null);
-        }
+        uninitializeHandlers();
         GlobalVars.initializeCalled = false;
         GlobalVars.initializeCompleted = false;
         GlobalVars.initializePromise = null;
@@ -3820,6 +3679,66 @@ var app;
         });
     }
     app.openLink = openLink;
+    /**
+     * A namespace for enabling the suspension or delayed termination of an app when the user navigates away.
+     * When an app registers for the registerBeforeSuspendOrTerminateHandler, it chooses to delay termination.
+     * When an app registers for both registerBeforeSuspendOrTerminateHandler and registerOnResumeHandler, it chooses the suspension of the app .
+     * Please note that selecting suspension doesn't guarantee prevention of background termination.
+     * The outcome is influenced by factors such as available memory and the number of suspended apps.
+     *
+     * @beta
+     */
+    var lifecycle;
+    (function (lifecycle) {
+        /**
+         * Registers a handler to be called before the page is suspended or terminated. Once a user navigates away from an app,
+         * the handler will be invoked. App developers can use this handler to save unsaved data, pause sync calls etc.
+         *
+         * @param handler - The handler to invoke before the page is suspended or terminated. When invoked, app can perform tasks like cleanups, logging etc.
+         * Upon returning, the app will be suspended or terminated.
+         *
+         */
+        function registerBeforeSuspendOrTerminateHandler(handler) {
+            if (!handler) {
+                throw new Error('[app.lifecycle.registerBeforeSuspendOrTerminateHandler] Handler cannot be null');
+            }
+            if (!isSupported()) {
+                throw errorNotSupportedOnPlatform;
+            }
+            handlers_registerBeforeSuspendOrTerminateHandler(handler);
+        }
+        lifecycle.registerBeforeSuspendOrTerminateHandler = registerBeforeSuspendOrTerminateHandler;
+        /**
+         * Registers a handler to be called when the page has been requested to resume from being suspended.
+         *
+         * @param handler - The handler to invoke when the page is requested to be resumed. The app is supposed to navigate to
+         * the appropriate page using the ResumeContext. Once done, the app should then call {@link notifySuccess}.
+         *
+         * @beta
+         */
+        function registerOnResumeHandler(handler) {
+            if (!handler) {
+                throw new Error('[app.lifecycle.registerOnResumeHandler] Handler cannot be null');
+            }
+            if (!isSupported()) {
+                throw errorNotSupportedOnPlatform;
+            }
+            handlers_registerOnResumeHandler(handler);
+        }
+        lifecycle.registerOnResumeHandler = registerOnResumeHandler;
+        /**
+         * Checks if app.lifecycle is supported by the host.
+         * @returns boolean to represent whether the lifecycle capability is supported
+         * @throws Error if {@linkcode app.initialize} has not successfully completed
+         *
+         * @beta
+         */
+        function isSupported() {
+            var _a;
+            return ensureInitialized(runtime) && !!((_a = runtime.supports.app) === null || _a === void 0 ? void 0 : _a.lifecycle);
+        }
+        lifecycle.isSupported = isSupported;
+    })(lifecycle = app.lifecycle || (app.lifecycle = {}));
 })(app || (app = {}));
 /**
  * @hidden
@@ -4681,6 +4600,33 @@ var handlersLogger = getLogger('handlers');
 var HandlersPrivate = /** @class */ (function () {
     function HandlersPrivate() {
     }
+    /**
+     * @internal
+     * Limited to Microsoft-internal use
+     * Initializes the handlers.
+     */
+    HandlersPrivate.initializeHandlers = function () {
+        // ::::::::::::::::::::MicrosoftTeams SDK Internal :::::::::::::::::
+        HandlersPrivate.handlers['themeChange'] = handleThemeChange;
+        HandlersPrivate.handlers['load'] = handleLoad;
+        HandlersPrivate.handlers['beforeUnload'] = handleBeforeUnload;
+        HandlersPrivate.handlers['beforeSuspendOrTerminate'] = handleBeforeSuspendOrTerminate;
+        HandlersPrivate.handlers['resume'] = handleResume;
+        pages.backStack._initialize();
+    };
+    /**
+     * @internal
+     * Limited to Microsoft-internal use
+     * Uninitializes the handlers.
+     */
+    HandlersPrivate.uninitializeHandlers = function () {
+        HandlersPrivate.handlers = {};
+        HandlersPrivate.themeChangeHandler = null;
+        HandlersPrivate.loadHandler = null;
+        HandlersPrivate.beforeUnloadHandler = null;
+        HandlersPrivate.beforeSuspendOrTerminateHandler = null;
+        HandlersPrivate.resumeHandler = null;
+    };
     HandlersPrivate.handlers = {};
     return HandlersPrivate;
 }());
@@ -4689,11 +4635,14 @@ var HandlersPrivate = /** @class */ (function () {
  * Limited to Microsoft-internal use
  */
 function initializeHandlers() {
-    // ::::::::::::::::::::MicrosoftTeams SDK Internal :::::::::::::::::
-    HandlersPrivate.handlers['themeChange'] = handleThemeChange;
-    HandlersPrivate.handlers['load'] = handleLoad;
-    HandlersPrivate.handlers['beforeUnload'] = handleBeforeUnload;
-    pages.backStack._initialize();
+    HandlersPrivate.initializeHandlers();
+}
+/**
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+function uninitializeHandlers() {
+    HandlersPrivate.uninitializeHandlers();
 }
 var callHandlerLogger = handlersLogger.extend('callHandler');
 /**
@@ -4788,6 +4737,8 @@ function handleThemeChange(theme) {
 /**
  * @internal
  * Limited to Microsoft-internal use
+ *
+ * @deprecated
  */
 function handlers_registerOnLoadHandler(handler) {
     HandlersPrivate.loadHandler = handler;
@@ -4796,6 +4747,8 @@ function handlers_registerOnLoadHandler(handler) {
 /**
  * @internal
  * Limited to Microsoft-internal use
+ *
+ * @deprecated
  */
 function handleLoad(context) {
     if (HandlersPrivate.loadHandler) {
@@ -4808,6 +4761,8 @@ function handleLoad(context) {
 /**
  * @internal
  * Limited to Microsoft-internal use
+ *
+ * @deprecated
  */
 function handlers_registerBeforeUnloadHandler(handler) {
     HandlersPrivate.beforeUnloadHandler = handler;
@@ -4816,6 +4771,8 @@ function handlers_registerBeforeUnloadHandler(handler) {
 /**
  * @internal
  * Limited to Microsoft-internal use
+ *
+ * @deprecated
  */
 function handleBeforeUnload() {
     var readyToUnload = function () {
@@ -4830,6 +4787,52 @@ function handleBeforeUnload() {
         }
     }
 }
+/**
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+function handlers_registerBeforeSuspendOrTerminateHandler(handler) {
+    HandlersPrivate.beforeSuspendOrTerminateHandler = handler;
+    handler && sendMessageToParent('registerHandler', ['beforeSuspendOrTerminate']);
+}
+/**
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+function handleBeforeSuspendOrTerminate() {
+    var readyToSuspendOrTerminate = function () {
+        sendMessageToParent('readyToSuspendOrTerminate', []);
+    };
+    if (HandlersPrivate.beforeSuspendOrTerminateHandler) {
+        HandlersPrivate.beforeSuspendOrTerminateHandler();
+    }
+    if (Communication.childWindow) {
+        sendMessageEventToChild('beforeSuspendOrTerminate');
+    }
+    else {
+        readyToSuspendOrTerminate();
+    }
+}
+/**
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+function handlers_registerOnResumeHandler(handler) {
+    HandlersPrivate.loadHandler = handler;
+    handler && sendMessageToParent('registerHandler', ['resume']);
+}
+/**
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+function handleResume(context) {
+    if (HandlersPrivate.loadHandler) {
+        HandlersPrivate.loadHandler(context);
+    }
+    if (Communication.childWindow) {
+        sendMessageEventToChild('resume', [context]);
+    }
+}
 
 ;// CONCATENATED MODULE: ./src/internal/communication.ts
 /* eslint-disable @typescript-eslint/ban-types */
@@ -7952,6 +7955,145 @@ var mail;
     })(ComposeMailType = mail.ComposeMailType || (mail.ComposeMailType = {}));
 })(mail || (mail = {}));
 
+;// CONCATENATED MODULE: ./src/public/teamsAPIs.ts
+
+ // Conflict with some names
+
+
+
+
+/**
+ * Namespace containing the set of APIs that support Teams-specific functionalities.
+ */
+var teamsCore;
+(function (teamsCore) {
+    /**
+     * Enable print capability to support printing page using Ctrl+P and cmd+P
+     */
+    function enablePrintCapability() {
+        if (!GlobalVars.printCapabilityEnabled) {
+            ensureInitialized(runtime);
+            if (!isSupported()) {
+                throw errorNotSupportedOnPlatform;
+            }
+            GlobalVars.printCapabilityEnabled = true;
+            // adding ctrl+P and cmd+P handler
+            document.addEventListener('keydown', function (event) {
+                if ((event.ctrlKey || event.metaKey) && event.keyCode === 80) {
+                    print();
+                    event.cancelBubble = true;
+                    event.preventDefault();
+                    event.stopImmediatePropagation();
+                }
+            });
+        }
+    }
+    teamsCore.enablePrintCapability = enablePrintCapability;
+    /**
+     * default print handler
+     */
+    function print() {
+        ssrSafeWindow().print();
+    }
+    teamsCore.print = print;
+    /**
+     * 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.
+     *
+     * @deprecated
+     * As of 2.14.1, please use {@link app.lifecycle.registerOnResumeHandler} instead.
+     *
+     * @beta
+     */
+    function registerOnLoadHandler(handler) {
+        registerOnLoadHandlerHelper(handler, function () {
+            if (handler && !isSupported()) {
+                throw errorNotSupportedOnPlatform;
+            }
+        });
+    }
+    teamsCore.registerOnLoadHandler = registerOnLoadHandler;
+    /**
+     * @hidden
+     * Undocumented helper function with shared code between deprecated version and current version of the registerOnLoadHandler API.
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     *
+     * @param handler - The handler to invoke when the page is loaded.
+     * @param versionSpecificHelper - The helper function containing logic pertaining to a specific version of the API.
+     *
+     * @deprecated
+     */
+    function registerOnLoadHandlerHelper(handler, versionSpecificHelper) {
+        // allow for registration cleanup even when not finished initializing
+        handler && ensureInitialized(runtime);
+        if (handler && versionSpecificHelper) {
+            versionSpecificHelper();
+        }
+        handlers_registerOnLoadHandler(handler);
+    }
+    teamsCore.registerOnLoadHandlerHelper = registerOnLoadHandlerHelper;
+    /**
+     * 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.
+     *
+     * @deprecated
+     * @beta
+     */
+    function registerBeforeUnloadHandler(handler) {
+        registerBeforeUnloadHandlerHelper(handler, function () {
+            if (handler && !isSupported()) {
+                throw errorNotSupportedOnPlatform;
+            }
+        });
+    }
+    teamsCore.registerBeforeUnloadHandler = registerBeforeUnloadHandler;
+    /**
+     * @hidden
+     * Undocumented helper function with shared code between deprecated version and current version of the registerBeforeUnloadHandler API.
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     *
+     * @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.
+     * @param versionSpecificHelper - The helper function containing logic pertaining to a specific version of the API.
+     *
+     * @deprecated
+     */
+    function registerBeforeUnloadHandlerHelper(handler, versionSpecificHelper) {
+        // allow for registration cleanup even when not finished initializing
+        handler && ensureInitialized(runtime);
+        if (handler && versionSpecificHelper) {
+            versionSpecificHelper();
+        }
+        handlers_registerBeforeUnloadHandler(handler);
+    }
+    teamsCore.registerBeforeUnloadHandlerHelper = registerBeforeUnloadHandlerHelper;
+    /**
+     * Checks if teamsCore capability is supported by the host
+     *
+     * @returns boolean to represent whether the teamsCore capability is supported
+     *
+     * @throws Error if {@linkcode app.initialize} has not successfully completed
+     *
+     */
+    function isSupported() {
+        return ensureInitialized(runtime) && runtime.supports.teamsCore ? true : false;
+    }
+    teamsCore.isSupported = isSupported;
+})(teamsCore || (teamsCore = {}));
+
 ;// CONCATENATED MODULE: ./src/public/people.ts