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

package/dist/MicrosoftTeams.d.ts

@@ -261,6 +261,15 @@ export function registerCustomHandler(actionName: string, customHandler: (...arg
     * @internal
     */
 export function registerUserSettingsChangeHandler(settingTypes: UserSettingTypes[], handler: (settingType: UserSettingTypes, value: any) => void): void;
+/**
+    * @hidden
+    * Hide from docs.
+    * ------
+    * Opens a client-friendly preview of the specified file.
+    *
+    * @param file - The file to preview.
+    */
+export function openFilePreview(filePreviewParameters: FilePreviewParameters): void;
 
 /**
     * @hidden
@@ -379,8 +388,6 @@ export namespace conversations {
     * Hide from docs
     * ------
     * Namespace to interact with the files specific part of the SDK.
-    *
-    * @alpha
     */
 export namespace files {
         /**
@@ -439,6 +446,7 @@ export namespace files {
             * @hidden
             * Hide from docs
             * ------
+            *
             * Cloud storage folder interface
             */
         export interface CloudStorageFolder {
@@ -497,6 +505,7 @@ export namespace files {
             * @hidden
             * Hide from docs
             * ------
+            *
             * Cloud storage item interface
             */
         export interface CloudStorageFolderItem {
@@ -658,44 +667,51 @@ export namespace files {
         /**
             * @hidden
             * Hide from docs
-            * ------
-            * Gets a list of cloud storage folders added to the channel
             *
+            * Gets a list of cloud storage folders added to the channel
             * @param channelId - ID of the channel whose cloud storage folders should be retrieved
+            * @param callback - Callback that will be triggered post folders load
             */
-        export function getCloudStorageFolders(channelId: string): Promise<CloudStorageFolder[]>;
+        export function getCloudStorageFolders(channelId: string, callback: (error: SdkError, folders: CloudStorageFolder[]) => void): void;
         /**
             * @hidden
             * Hide from docs
             * ------
             * Initiates the add cloud storage folder flow
+            *
             * @param channelId - ID of the channel to add cloud storage folder
+            * @param callback - Callback that will be triggered post add folder flow is compelete
             */
-        export function addCloudStorageFolder(channelId: string): Promise<[boolean, CloudStorageFolder[]]>;
+        export function addCloudStorageFolder(channelId: string, callback: (error: SdkError, isFolderAdded: boolean, folders: CloudStorageFolder[]) => void): void;
         /**
             * @hidden
             * Hide from docs
             * ------
+            *
             * Deletes a cloud storage folder from channel
             *
             * @param channelId - ID of the channel where folder is to be deleted
             * @param folderToDelete - cloud storage folder to be deleted
+            * @param callback - Callback that will be triggered post delete
             */
-        export function deleteCloudStorageFolder(channelId: string, folderToDelete: CloudStorageFolder): Promise<boolean>;
+        export function deleteCloudStorageFolder(channelId: string, folderToDelete: CloudStorageFolder, callback: (error: SdkError, isFolderDeleted: boolean) => void): void;
         /**
             * @hidden
             * Hide from docs
             * ------
+            *
             * Fetches the contents of a Cloud storage folder (CloudStorageFolder) / sub directory
             *
             * @param folder - Cloud storage folder (CloudStorageFolder) / sub directory (CloudStorageFolderItem)
             * @param providerCode - Code of the cloud storage folder provider
+            * @param callback - Callback that will be triggered post contents are loaded
             */
-        export function getCloudStorageFolderContents(folder: CloudStorageFolder | CloudStorageFolderItem, providerCode: CloudStorageProvider): Promise<CloudStorageFolderItem[]>;
+        export function getCloudStorageFolderContents(folder: CloudStorageFolder | CloudStorageFolderItem, providerCode: CloudStorageProvider, callback: (error: SdkError, items: CloudStorageFolderItem[]) => void): void;
         /**
             * @hidden
             * Hide from docs
             * ------
+            *
             * Open a cloud storage file in teams
             *
             * @param file - cloud storage file that should be opened
@@ -703,15 +719,6 @@ export namespace files {
             * @param fileOpenPreference - Whether file should be opened in web/inline
             */
         export function openCloudStorageFile(file: CloudStorageFolderItem, providerCode: CloudStorageProvider, fileOpenPreference?: FileOpenPreference.Web | FileOpenPreference.Inline): void;
-        /**
-            * @hidden
-            * Hide from docs.
-            * ------
-            * Opens a client-friendly preview of the specified file.
-            *
-            * @param file - The file to preview.
-            */
-        export function openFilePreview(filePreviewParameters: FilePreviewParameters): void;
         /**
             * @hidden
             * Allow 1st party apps to call this function to get the external
@@ -719,29 +726,18 @@ export namespace files {
             * @param excludeAddedProviders: return a list of support third party
             * cloud storages that hasn't been added yet.
             */
-        export function getExternalProviders(excludeAddedProviders?: boolean): Promise<IExternalProvider[]>;
+        export function getExternalProviders(excludeAddedProviders: boolean, callback: (error: SdkError, providers: IExternalProvider[]) => void): void;
         /**
             * @hidden
             * Allow 1st party apps to call this function to move files
             * among SharePoint and third party cloud storages.
             */
-        export function copyMoveFiles(selectedFiles: CloudStorageFolderItem[] | ISharePointFile[], providerCode: CloudStorageProvider, destinationFolder: CloudStorageFolderItem | ISharePointFile, destinationProviderCode: CloudStorageProvider, isMove?: boolean): Promise<void>;
-        export function isSupported(): boolean;
-        /**
-            * @hidden
-            * Hide from docs
-            * ------
-            * Gets list of downloads for current user
-            * @param callback Callback that will be triggered post downloads load
-            */
-        export function getFileDownloads(): Promise<IFileItem[]>;
+        export function copyMoveFiles(selectedFiles: CloudStorageFolderItem[] | ISharePointFile[], providerCode: CloudStorageProvider, destinationFolder: CloudStorageFolderItem | ISharePointFile, destinationProviderCode: CloudStorageProvider, isMove: boolean, callback: (error?: SdkError) => void): void;
         /**
             * @hidden
             * Hide from docs
-            * ------
+            *  ------
             *
-            * @deprecated
-            * As of 2.0.0-beta.4, please use {@link file.getFileDownloads file.getFileDownloads(): Promise\<IFileItem[]\>} instead.
             * Gets list of downloads for current user
             * @param callback Callback that will be triggered post downloads load
             */
@@ -751,7 +747,7 @@ export namespace files {
             * Hide from docs
             *
             * Open download preference folder if fileObjectId value is undefined else open folder containing the file with id fileObjectId
-            * @param fileObjectId Id of the file whose containing folder should be opened
+            * @param fileObjectId - Id of the file whose containing folder should be opened
             * @param callback Callback that will be triggered post open download folder/path
             */
         export function openDownloadFolder(fileObjectId: string, callback: (error?: SdkError) => void): void;

package/dist/MicrosoftTeams.js

@@ -1089,6 +1089,7 @@ __webpack_require__.d(__webpack_exports__, {
   "navigateCrossDomain": () => (/* reexport */ navigateCrossDomain),
   "navigateToTab": () => (/* reexport */ navigateToTab),
   "notifications": () => (/* reexport */ notifications),
+  "openFilePreview": () => (/* reexport */ openFilePreview),
   "pages": () => (/* reexport */ pages),
   "people": () => (/* reexport */ people),
   "print": () => (/* reexport */ print),
@@ -1121,7 +1122,7 @@ __webpack_require__.d(__webpack_exports__, {
 });
 
 ;// CONCATENATED MODULE: ./src/internal/constants.ts
-var version = "2.0.0-beta.6-dev.5";
+var version = "2.0.0-beta.6-dev.6";
 /**
  * @hidden
  * The client version when all SDK APIs started to check platform compatibility for the APIs was 1.6.0.
@@ -1831,6 +1832,7 @@ function processAdditionalValidOrigins(validMessageOrigins) {
 
 
 
+
 /**
  * @internal
  */
@@ -1926,6 +1928,34 @@ function registerUserSettingsChangeHandler(settingTypes, handler) {
     ensureInitialized();
     registerHandler('userSettingsChange', handler, true, [settingTypes]);
 }
+/**
+ * @hidden
+ * Hide from docs.
+ * ------
+ * Opens a client-friendly preview of the specified file.
+ *
+ * @param file - The file to preview.
+ */
+function openFilePreview(filePreviewParameters) {
+    ensureInitialized(FrameContexts.content, FrameContexts.task);
+    var params = [
+        filePreviewParameters.entityId,
+        filePreviewParameters.title,
+        filePreviewParameters.description,
+        filePreviewParameters.type,
+        filePreviewParameters.objectUrl,
+        filePreviewParameters.downloadUrl,
+        filePreviewParameters.webPreviewUrl,
+        filePreviewParameters.webEditUrl,
+        filePreviewParameters.baseUrl,
+        filePreviewParameters.editFile,
+        filePreviewParameters.subEntityId,
+        filePreviewParameters.viewerAction,
+        filePreviewParameters.fileOpenPreference,
+        filePreviewParameters.conversationId,
+    ];
+    sendMessageToParent('openFilePreview', params);
+}
 
 ;// CONCATENATED MODULE: ./src/public/authentication.ts
 
@@ -2374,7 +2404,6 @@ var teamsRuntimeConfig = {
             bot: {},
             update: {},
         },
-        files: {},
         logs: {},
         media: {},
         meeting: {},
@@ -6842,16 +6871,11 @@ var tasks;
 
 
 
-
-
-
 /**
  * @hidden
  * Hide from docs
  * ------
  * Namespace to interact with the files specific part of the SDK.
- *
- * @alpha
  */
 var files;
 (function (files_1) {
@@ -6924,22 +6948,20 @@ var files;
     /**
      * @hidden
      * Hide from docs
-     * ------
-     * Gets a list of cloud storage folders added to the channel
      *
+     * Gets a list of cloud storage folders added to the channel
      * @param channelId - ID of the channel whose cloud storage folders should be retrieved
+     * @param callback - Callback that will be triggered post folders load
      */
-    function getCloudStorageFolders(channelId) {
-        return new Promise(function (resolve) {
-            ensureInitialized(FrameContexts.content);
-            if (!isSupported()) {
-                throw errorNotSupportedOnPlatform;
-            }
-            if (!channelId || channelId.length === 0) {
-                throw new Error('[files.getCloudStorageFolders] channelId name cannot be null or empty');
-            }
-            resolve(sendAndHandleSdkError('files.getCloudStorageFolders', channelId));
-        });
+    function getCloudStorageFolders(channelId, callback) {
+        ensureInitialized(FrameContexts.content);
+        if (!channelId || channelId.length === 0) {
+            throw new Error('[files.getCloudStorageFolders] channelId name cannot be null or empty');
+        }
+        if (!callback) {
+            throw new Error('[files.getCloudStorageFolders] Callback cannot be null');
+        }
+        sendMessageToParent('files.getCloudStorageFolders', [channelId], callback);
     }
     files_1.getCloudStorageFolders = getCloudStorageFolders;
     /**
@@ -6947,82 +6969,76 @@ var files;
      * Hide from docs
      * ------
      * Initiates the add cloud storage folder flow
+     *
      * @param channelId - ID of the channel to add cloud storage folder
+     * @param callback - Callback that will be triggered post add folder flow is compelete
      */
-    function addCloudStorageFolder(channelId) {
-        return new Promise(function (resolve) {
-            ensureInitialized(FrameContexts.content);
-            if (!isSupported()) {
-                throw errorNotSupportedOnPlatform;
-            }
-            if (!channelId || channelId.length === 0) {
-                throw new Error('[files.addCloudStorageFolder] channelId name cannot be null or empty');
-            }
-            resolve(sendMessageToParentAsync('files.addCloudStorageFolder', [channelId]));
-        }).then(function (_a) {
-            var error = _a[0], isFolderAdded = _a[1], folders = _a[2];
-            if (error) {
-                throw error;
-            }
-            var result = [isFolderAdded, folders];
-            return result;
-        });
+    function addCloudStorageFolder(channelId, callback) {
+        ensureInitialized(FrameContexts.content);
+        if (!channelId || channelId.length === 0) {
+            throw new Error('[files.addCloudStorageFolder] channelId name cannot be null or empty');
+        }
+        if (!callback) {
+            throw new Error('[files.addCloudStorageFolder] Callback cannot be null');
+        }
+        sendMessageToParent('files.addCloudStorageFolder', [channelId], callback);
     }
     files_1.addCloudStorageFolder = addCloudStorageFolder;
     /**
      * @hidden
      * Hide from docs
      * ------
+     *
      * Deletes a cloud storage folder from channel
      *
      * @param channelId - ID of the channel where folder is to be deleted
      * @param folderToDelete - cloud storage folder to be deleted
+     * @param callback - Callback that will be triggered post delete
      */
-    function deleteCloudStorageFolder(channelId, folderToDelete) {
-        return new Promise(function (resolve) {
-            ensureInitialized(FrameContexts.content);
-            if (!isSupported()) {
-                throw errorNotSupportedOnPlatform;
-            }
-            if (!channelId) {
-                throw new Error('[files.deleteCloudStorageFolder] channelId name cannot be null or empty');
-            }
-            if (!folderToDelete) {
-                throw new Error('[files.deleteCloudStorageFolder] folderToDelete cannot be null or empty');
-            }
-            resolve(sendAndHandleSdkError('files.deleteCloudStorageFolder', channelId, folderToDelete));
-        });
+    function deleteCloudStorageFolder(channelId, folderToDelete, callback) {
+        ensureInitialized(FrameContexts.content);
+        if (!channelId) {
+            throw new Error('[files.deleteCloudStorageFolder] channelId name cannot be null or empty');
+        }
+        if (!folderToDelete) {
+            throw new Error('[files.deleteCloudStorageFolder] folderToDelete cannot be null or empty');
+        }
+        if (!callback) {
+            throw new Error('[files.deleteCloudStorageFolder] Callback cannot be null');
+        }
+        sendMessageToParent('files.deleteCloudStorageFolder', [channelId, folderToDelete], callback);
     }
     files_1.deleteCloudStorageFolder = deleteCloudStorageFolder;
     /**
      * @hidden
      * Hide from docs
      * ------
+     *
      * Fetches the contents of a Cloud storage folder (CloudStorageFolder) / sub directory
      *
      * @param folder - Cloud storage folder (CloudStorageFolder) / sub directory (CloudStorageFolderItem)
      * @param providerCode - Code of the cloud storage folder provider
+     * @param callback - Callback that will be triggered post contents are loaded
      */
-    function getCloudStorageFolderContents(folder, providerCode) {
-        return new Promise(function (resolve) {
-            ensureInitialized(FrameContexts.content);
-            if (!isSupported()) {
-                throw errorNotSupportedOnPlatform;
-            }
-            if (!folder || !providerCode) {
-                throw new Error('[files.getCloudStorageFolderContents] folder/providerCode name cannot be null or empty');
-            }
-            if ('isSubdirectory' in folder && !folder.isSubdirectory) {
-                throw new Error('[files.getCloudStorageFolderContents] provided folder is not a subDirectory');
-            }
-            resolve(sendAndHandleSdkError('files.getCloudStorageFolderContents', folder, providerCode));
-        });
+    function getCloudStorageFolderContents(folder, providerCode, callback) {
+        ensureInitialized(FrameContexts.content);
+        if (!folder || !providerCode) {
+            throw new Error('[files.getCloudStorageFolderContents] folder/providerCode name cannot be null or empty');
+        }
+        if (!callback) {
+            throw new Error('[files.getCloudStorageFolderContents] Callback cannot be null');
+        }
+        if ('isSubdirectory' in folder && !folder.isSubdirectory) {
+            throw new Error('[files.getCloudStorageFolderContents] provided folder is not a subDirectory');
+        }
+        sendMessageToParent('files.getCloudStorageFolderContents', [folder, providerCode], callback);
     }
     files_1.getCloudStorageFolderContents = getCloudStorageFolderContents;
     /**
      * @hidden
      * Hide from docs
      * ------
+     *
      * Open a cloud storage file in teams
      *
      * @param file - cloud storage file that should be opened
@@ -7031,9 +7047,6 @@ var files;
      */
     function openCloudStorageFile(file, providerCode, fileOpenPreference) {
         ensureInitialized(FrameContexts.content);
-        if (!isSupported()) {
-            throw errorNotSupportedOnPlatform;
-        }
         if (!file || !providerCode) {
             throw new Error('[files.openCloudStorageFile] file/providerCode cannot be null or empty');
         }
@@ -7043,38 +7056,6 @@ var files;
         sendMessageToParent('files.openCloudStorageFile', [file, providerCode, fileOpenPreference]);
     }
     files_1.openCloudStorageFile = openCloudStorageFile;
-    /**
-     * @hidden
-     * Hide from docs.
-     * ------
-     * Opens a client-friendly preview of the specified file.
-     *
-     * @param file - The file to preview.
-     */
-    function openFilePreview(filePreviewParameters) {
-        ensureInitialized(FrameContexts.content);
-        if (!isSupported()) {
-            throw errorNotSupportedOnPlatform;
-        }
-        var params = [
-            filePreviewParameters.entityId,
-            filePreviewParameters.title,
-            filePreviewParameters.description,
-            filePreviewParameters.type,
-            filePreviewParameters.objectUrl,
-            filePreviewParameters.downloadUrl,
-            filePreviewParameters.webPreviewUrl,
-            filePreviewParameters.webEditUrl,
-            filePreviewParameters.baseUrl,
-            filePreviewParameters.editFile,
-            filePreviewParameters.subEntityId,
-            filePreviewParameters.viewerAction,
-            filePreviewParameters.fileOpenPreference,
-            filePreviewParameters.conversationId,
-        ];
-        sendMessageToParent('openFilePreview', params);
-    }
-    files_1.openFilePreview = openFilePreview;
     /**
      * @hidden
      * Allow 1st party apps to call this function to get the external
@@ -7082,15 +7063,13 @@ var files;
      * @param excludeAddedProviders: return a list of support third party
      * cloud storages that hasn't been added yet.
      */
-    function getExternalProviders(excludeAddedProviders) {
+    function getExternalProviders(excludeAddedProviders, callback) {
         if (excludeAddedProviders === void 0) { excludeAddedProviders = false; }
-        return new Promise(function (resolve) {
-            ensureInitialized(FrameContexts.content);
-            if (!isSupported()) {
-                throw errorNotSupportedOnPlatform;
-            }
-            resolve(sendAndHandleSdkError('files.getExternalProviders', excludeAddedProviders));
-        });
+        ensureInitialized(FrameContexts.content);
+        if (!callback) {
+            throw new Error('[files.getExternalProviders] Callback cannot be null');
+        }
+        sendMessageToParent('files.getExternalProviders', [excludeAddedProviders], callback);
     }
     files_1.getExternalProviders = getExternalProviders;
     /**
@@ -7098,42 +7077,41 @@ var files;
      * Allow 1st party apps to call this function to move files
      * among SharePoint and third party cloud storages.
      */
-    function copyMoveFiles(selectedFiles, providerCode, destinationFolder, destinationProviderCode, isMove) {
+    function copyMoveFiles(selectedFiles, providerCode, destinationFolder, destinationProviderCode, isMove, callback) {
         if (isMove === void 0) { isMove = false; }
-        return new Promise(function (resolve) {
-            ensureInitialized(FrameContexts.content);
-            if (!isSupported()) {
-                throw errorNotSupportedOnPlatform;
-            }
-            if (!selectedFiles || selectedFiles.length === 0) {
-                throw new Error('[files.copyMoveFiles] selectedFiles cannot be null or empty');
-            }
-            if (!providerCode) {
-                throw new Error('[files.copyMoveFiles] providerCode cannot be null or empty');
-            }
-            if (!destinationFolder) {
-                throw new Error('[files.copyMoveFiles] destinationFolder cannot be null or empty');
-            }
-            if (!destinationProviderCode) {
-                throw new Error('[files.copyMoveFiles] destinationProviderCode cannot be null or empty');
-            }
-            resolve(sendAndHandleSdkError('files.copyMoveFiles', selectedFiles, providerCode, destinationFolder, destinationProviderCode, isMove));
-        });
+        ensureInitialized(FrameContexts.content);
+        if (!selectedFiles || selectedFiles.length === 0) {
+            throw new Error('[files.copyMoveFiles] selectedFiles cannot be null or empty');
+        }
+        if (!providerCode) {
+            throw new Error('[files.copyMoveFiles] providerCode cannot be null or empty');
+        }
+        if (!destinationFolder) {
+            throw new Error('[files.copyMoveFiles] destinationFolder cannot be null or empty');
+        }
+        if (!destinationProviderCode) {
+            throw new Error('[files.copyMoveFiles] destinationProviderCode cannot be null or empty');
+        }
+        if (!callback) {
+            throw new Error('[files.copyMoveFiles] callback cannot be null');
+        }
+        sendMessageToParent('files.copyMoveFiles', [selectedFiles, providerCode, destinationFolder, destinationProviderCode, isMove], callback);
     }
     files_1.copyMoveFiles = copyMoveFiles;
-    function isSupported() {
-        return runtime.supports.files ? true : false;
-    }
-    files_1.isSupported = isSupported;
+    /**
+     * @hidden
+     * Hide from docs
+     *  ------
+     *
+     * Gets list of downloads for current user
+     * @param callback Callback that will be triggered post downloads load
+     */
     function getFileDownloads(callback) {
         ensureInitialized(FrameContexts.content);
-        if (!isSupported()) {
-            throw errorNotSupportedOnPlatform;
+        if (!callback) {
+            throw new Error('[files.getFileDownloads] Callback cannot be null');
         }
-        var wrappedFunction = function () {
-            return new Promise(function (resolve) { return resolve(sendAndHandleSdkError('files.getFileDownloads', [])); });
-        };
-        return callCallbackWithErrorOrResultFromPromiseAndReturnPromise(wrappedFunction, callback);
+        sendMessageToParent('files.getFileDownloads', [], callback);
     }
     files_1.getFileDownloads = getFileDownloads;
     /**
@@ -7141,15 +7119,12 @@ var files;
      * Hide from docs
      *
      * Open download preference folder if fileObjectId value is undefined else open folder containing the file with id fileObjectId
-     * @param fileObjectId Id of the file whose containing folder should be opened
+     * @param fileObjectId - Id of the file whose containing folder should be opened
      * @param callback Callback that will be triggered post open download folder/path
      */
     function openDownloadFolder(fileObjectId, callback) {
         if (fileObjectId === void 0) { fileObjectId = undefined; }
         ensureInitialized(FrameContexts.content);
-        if (!isSupported()) {
-            throw errorNotSupportedOnPlatform;
-        }
         if (!callback) {
             throw new Error('[files.openDownloadFolder] Callback cannot be null');
         }