@microsoft/teams-js 2.0.0-beta.5-dev.6 → 2.0.0-beta.5-dev.9

package/dist/MicrosoftTeams.d.ts

@@ -2086,6 +2086,26 @@ export interface Context {
             */
         mySitePath?: string;
 }
+export interface ShareDeepLinkParameters {
+        /**
+            * The developer-defined unique ID for the sub-page to which this deep link points in the current page.
+            * This field should be used to restore to a specific state within a page, such as scrolling to or activating a specific piece of content.
+            */
+        subPageId: string;
+        /**
+            * The label for the sub-page that should be displayed when the deep link is rendered in a client.
+            */
+        subPageLabel: string;
+        /**
+            * The fallback URL to which to navigate the user if the client cannot render the page.
+            * This URL should lead directly to the sub-entity.
+            */
+        subPageWebUrl?: string;
+}
+/**
+    * @deprecated
+    * As of 2.0.0-beta.5, please use {@link ShareDeepLinkParameters} instead.
+    */
 export interface DeepLinkParameters {
         /**
             * The developer-defined unique ID for the sub-entity to which this deep link points in the current entity.
@@ -2973,7 +2993,7 @@ export namespace pages {
             *
             * @param deepLinkParameters - ID and label for the link and fallback URL.
             */
-        function shareDeepLink(deepLinkParameters: DeepLinkParameters): void;
+        function shareDeepLink(deepLinkParameters: ShareDeepLinkParameters): void;
         /**
             * Registers a handler for changes from or to full-screen view for a tab.
             * Only one handler can be registered at a time. A subsequent registration replaces an existing registration.

package/dist/MicrosoftTeams.js

@@ -1121,7 +1121,7 @@ __webpack_require__.d(__webpack_exports__, {
 });
 
 ;// CONCATENATED MODULE: ./src/internal/constants.ts
-var version = "2.0.0-beta.5-dev.6";
+var version = "2.0.0-beta.5-dev.9";
 /**
  * @hidden
  * The client version when all SDK APIs started to check platform compatibility for the APIs was 1.6.0.
@@ -3144,9 +3144,9 @@ var pages;
     function shareDeepLink(deepLinkParameters) {
         ensureInitialized(FrameContexts.content, FrameContexts.sidePanel, FrameContexts.meetingStage);
         sendMessageToParent('shareDeepLink', [
-            deepLinkParameters.subEntityId,
-            deepLinkParameters.subEntityLabel,
-            deepLinkParameters.subEntityWebUrl,
+            deepLinkParameters.subPageId,
+            deepLinkParameters.subPageLabel,
+            deepLinkParameters.subPageWebUrl,
         ]);
     }
     pages.shareDeepLink = shareDeepLink;
@@ -4425,7 +4425,7 @@ var dialog;
     function submit(result, appIds) {
         ensureInitialized(FrameContexts.content, FrameContexts.sidePanel, FrameContexts.task, FrameContexts.meetingStage);
         // Send tasks.completeTask instead of tasks.submitTask message for backward compatibility with Mobile clients
-        sendMessageToParent('tasks.completeTask', [result, Array.isArray(appIds) ? appIds : [appIds]]);
+        sendMessageToParent('tasks.completeTask', [result, appIds ? (Array.isArray(appIds) ? appIds : [appIds]) : []]);
     }
     dialog.submit = submit;
     /**
@@ -6223,7 +6223,11 @@ function getMruTabInstances(callback, tabInstanceParameters) {
  * @param deepLinkParameters - ID and label for the link and fallback URL.
  */
 function shareDeepLink(deepLinkParameters) {
-    pages.shareDeepLink(deepLinkParameters);
+    pages.shareDeepLink({
+        subPageId: deepLinkParameters.subEntityId,
+        subPageLabel: deepLinkParameters.subEntityLabel,
+        subPageWebUrl: deepLinkParameters.subEntityWebUrl,
+    });
 }
 /**
  * @deprecated
@@ -6683,6 +6687,7 @@ var tasks;
 
 
 
+
 /**
  * @hidden
  * Hide from docs
@@ -6770,6 +6775,9 @@ var files;
     function getCloudStorageFolders(channelId) {
         return new Promise(function (resolve) {
             ensureInitialized(FrameContexts.content);
+            if (!isSupported()) {
+                throw new Error(errorNotSupportedOnPlatform);
+            }
             if (!channelId || channelId.length === 0) {
                 throw new Error('[files.getCloudStorageFolders] channelId name cannot be null or empty');
             }
@@ -6787,6 +6795,9 @@ var files;
     function addCloudStorageFolder(channelId) {
         return new Promise(function (resolve) {
             ensureInitialized(FrameContexts.content);
+            if (!isSupported()) {
+                throw new Error(errorNotSupportedOnPlatform);
+            }
             if (!channelId || channelId.length === 0) {
                 throw new Error('[files.addCloudStorageFolder] channelId name cannot be null or empty');
             }
@@ -6813,6 +6824,9 @@ var files;
     function deleteCloudStorageFolder(channelId, folderToDelete) {
         return new Promise(function (resolve) {
             ensureInitialized(FrameContexts.content);
+            if (!isSupported()) {
+                throw new Error(errorNotSupportedOnPlatform);
+            }
             if (!channelId) {
                 throw new Error('[files.deleteCloudStorageFolder] channelId name cannot be null or empty');
             }
@@ -6835,6 +6849,9 @@ var files;
     function getCloudStorageFolderContents(folder, providerCode) {
         return new Promise(function (resolve) {
             ensureInitialized(FrameContexts.content);
+            if (!isSupported()) {
+                throw new Error(errorNotSupportedOnPlatform);
+            }
             if (!folder || !providerCode) {
                 throw new Error('[files.getCloudStorageFolderContents] folder/providerCode name cannot be null or empty');
             }
@@ -6857,6 +6874,9 @@ var files;
      */
     function openCloudStorageFile(file, providerCode, fileOpenPreference) {
         ensureInitialized(FrameContexts.content);
+        if (!isSupported()) {
+            throw new Error(errorNotSupportedOnPlatform);
+        }
         if (!file || !providerCode) {
             throw new Error('[files.openCloudStorageFile] file/providerCode cannot be null or empty');
         }
@@ -6876,6 +6896,9 @@ var files;
      */
     function openFilePreview(filePreviewParameters) {
         ensureInitialized(FrameContexts.content);
+        if (!isSupported()) {
+            throw new Error(errorNotSupportedOnPlatform);
+        }
         var params = [
             filePreviewParameters.entityId,
             filePreviewParameters.title,
@@ -6906,6 +6929,9 @@ var files;
         if (excludeAddedProviders === void 0) { excludeAddedProviders = false; }
         return new Promise(function (resolve) {
             ensureInitialized(FrameContexts.content);
+            if (!isSupported()) {
+                throw new Error(errorNotSupportedOnPlatform);
+            }
             resolve(sendAndHandleSdkError('files.getExternalProviders', excludeAddedProviders));
         });
     }
@@ -6919,6 +6945,9 @@ var files;
         if (isMove === void 0) { isMove = false; }
         return new Promise(function (resolve) {
             ensureInitialized(FrameContexts.content);
+            if (!isSupported()) {
+                throw new Error(errorNotSupportedOnPlatform);
+            }
             if (!selectedFiles || selectedFiles.length === 0) {
                 throw new Error('[files.copyMoveFiles] selectedFiles cannot be null or empty');
             }
@@ -6941,6 +6970,9 @@ var files;
     files_1.isSupported = isSupported;
     function getFileDownloads(callback) {
         ensureInitialized(FrameContexts.content);
+        if (!isSupported()) {
+            throw new Error(errorNotSupportedOnPlatform);
+        }
         var wrappedFunction = function () {
             return new Promise(function (resolve) { return resolve(sendAndHandleSdkError('files.getFileDownloads', [])); });
         };
@@ -6958,6 +6990,9 @@ var files;
     function openDownloadFolder(fileObjectId, callback) {
         if (fileObjectId === void 0) { fileObjectId = undefined; }
         ensureInitialized(FrameContexts.content);
+        if (!isSupported()) {
+            throw new Error(errorNotSupportedOnPlatform);
+        }
         if (!callback) {
             throw new Error('[files.openDownloadFolder] Callback cannot be null');
         }