@microsoft/teams-js 2.0.0-beta.2 → 2.0.0-beta.3-dev.2

package/dist/MicrosoftTeams.d.ts

@@ -1,26 +1,5 @@
 // Generated by dts-bundle v0.7.3
 
-/**
-    * @deprecated
-    * As of 2.0.0-beta.1.
-    */
-/**
-    * @deprecated
-    * As of 2.0.0-beta.1.
-    */
-/**
-    * @deprecated
-    * As of 2.0.0-beta.1.
-    */
-/**
-    * @deprecated
-    * As of 2.0.0-beta.1.
-    */
-/**
-    * @deprecated
-    * As of 2.0.0-beta.1.
-    */
-
 /**
     * @hidden
     * Namespace to interact with bots using the SDK.
@@ -569,23 +548,51 @@ export namespace files {
             * ------
             * Cloud storage providers registered with Microsoft Teams
             */
-        enum CloudStorageProvider {
+        export enum CloudStorageProvider {
                 Dropbox = "DROPBOX",
                 Box = "BOX",
                 Sharefile = "SHAREFILE",
                 GoogleDrive = "GOOGLEDRIVE",
-                Egnyte = "EGNYTE"
+                Egnyte = "EGNYTE",
+                SharePoint = "SharePoint"
+        }
+        interface IWopiThumbnail {
+                size: number;
+                url: string;
+        }
+        interface IWopiService {
+                name: string;
+                description: string;
+                thumbnails: IWopiThumbnail[];
         }
         /**
             * @hidden
             * Hide from docs
             * ------
-            * Cloud storage provider integration type
+            *
+            * External third-party cloud storages providers interface
+            */
+        export interface IExternalProvider extends IWopiService {
+                providerType: CloudStorageProviderType;
+                providerCode: CloudStorageProvider;
+        }
+        /**
+            * @hidden
+            * Hide from docs
+            *
+            * Cloud storage provider type enums
             */
-        enum CloudStorageProviderType {
+        export enum CloudStorageProviderType {
                 Sharepoint = 0,
                 WopiIntegration = 1,
-                Google = 2
+                Google = 2,
+                OneDrive = 3,
+                Recent = 4,
+                Aggregate = 5,
+                FileSystem = 6,
+                Search = 7,
+                AllFiles = 8,
+                SharedWithMe = 9
         }
         /**
             * @hidden
@@ -593,7 +600,7 @@ export namespace files {
             * ------
             * Cloud storage folder interface
             */
-        interface CloudStorageFolder {
+        export interface CloudStorageFolder {
                 /**
                     * @hidden
                     * ID of the cloud storage folder
@@ -651,7 +658,7 @@ export namespace files {
             * ------
             * Cloud storage item interface
             */
-        interface CloudStorageFolderItem {
+        export interface CloudStorageFolderItem {
                 /**
                     * @hidden
                     * ID of the item in the provider
@@ -693,6 +700,73 @@ export namespace files {
                     */
                 accessToken?: string;
         }
+        /**
+            * @hidden
+            * Hide from docs
+            *
+            * Files entity user interface
+            */
+        export interface IFilesEntityUser {
+                /**
+                    * User name.
+                    */
+                displayName: string;
+                /**
+                    * User email.
+                    */
+                email: string;
+                /**
+                    * User MRI.
+                    */
+                mri: string;
+        }
+        /**
+            * @hidden
+            * Hide from docs
+            *
+            * Special Document Library enum
+            */
+        export enum SpecialDocumentLibraryType {
+                ClassMaterials = "classMaterials"
+        }
+        /**
+            * @hidden
+            * Hide from docs
+            *
+            * Document Library Access enum
+            */
+        export enum DocumentLibraryAccessType {
+                Readonly = "readonly"
+        }
+        /**
+            * @hidden
+            * Hide from docs
+            *
+            * SharePoint file interface
+            */
+        export interface ISharePointFile {
+                siteId?: string;
+                siteUrl: string;
+                objectId: string;
+                objectUrl: string;
+                openInWindowFileUrl: string;
+                title: string;
+                isFolder: boolean;
+                serverRelativeUrl: string;
+                lastModifiedByUser: IFilesEntityUser;
+                lastModifiedTime: string;
+                sentByUser: IFilesEntityUser;
+                createdByUser: IFilesEntityUser;
+                createdTime: string;
+                size: number;
+                type: string;
+                spItemUrl?: string;
+                libraryType?: SpecialDocumentLibraryType;
+                accessType?: DocumentLibraryAccessType;
+                etag?: string;
+                remoteItem?: string;
+                listUrl?: string;
+        }
         /**
             * @hidden
             * Hide from docs
@@ -701,7 +775,7 @@ export namespace files {
             *
             * @param channelId - ID of the channel whose cloud storage folders should be retrieved
             */
-        function getCloudStorageFolders(channelId: string): Promise<CloudStorageFolder[]>;
+        export function getCloudStorageFolders(channelId: string): Promise<CloudStorageFolder[]>;
         /**
             * @hidden
             * Hide from docs
@@ -709,7 +783,7 @@ export namespace files {
             * Initiates the add cloud storage folder flow
             * @param channelId - ID of the channel to add cloud storage folder
             */
-        function addCloudStorageFolder(channelId: string): Promise<[boolean, CloudStorageFolder[]]>;
+        export function addCloudStorageFolder(channelId: string): Promise<[boolean, CloudStorageFolder[]]>;
         /**
             * @hidden
             * Hide from docs
@@ -719,7 +793,7 @@ export namespace files {
             * @param channelId - ID of the channel where folder is to be deleted
             * @param folderToDelete - cloud storage folder to be deleted
             */
-        function deleteCloudStorageFolder(channelId: string, folderToDelete: CloudStorageFolder): Promise<boolean>;
+        export function deleteCloudStorageFolder(channelId: string, folderToDelete: CloudStorageFolder): Promise<boolean>;
         /**
             * @hidden
             * Hide from docs
@@ -730,7 +804,7 @@ export namespace files {
             * @param providerCode - Code of the cloud storage folder provider
             * @param callback - Callback that will be triggered post contents are loaded
             */
-        function getCloudStorageFolderContents(folder: CloudStorageFolder | CloudStorageFolderItem, providerCode: CloudStorageProvider): Promise<CloudStorageFolderItem[]>;
+        export function getCloudStorageFolderContents(folder: CloudStorageFolder | CloudStorageFolderItem, providerCode: CloudStorageProvider): Promise<CloudStorageFolderItem[]>;
         /**
             * @hidden
             * Hide from docs
@@ -741,7 +815,7 @@ export namespace files {
             * @param providerCode - Code of the cloud storage folder provider
             * @param fileOpenPreference - Whether file should be opened in web/inline
             */
-        function openCloudStorageFile(file: CloudStorageFolderItem, providerCode: CloudStorageProvider, fileOpenPreference?: FileOpenPreference.Web | FileOpenPreference.Inline): void;
+        export function openCloudStorageFile(file: CloudStorageFolderItem, providerCode: CloudStorageProvider, fileOpenPreference?: FileOpenPreference.Web | FileOpenPreference.Inline): void;
         /**
             * @hidden
             * Hide from docs.
@@ -750,8 +824,23 @@ export namespace files {
             *
             * @param file - The file to preview.
             */
-        function openFilePreview(filePreviewParameters: FilePreviewParameters): void;
-        function isSupported(): boolean;
+        export function openFilePreview(filePreviewParameters: FilePreviewParameters): void;
+        /**
+            * @hidden
+            * Allow 1st party apps to call this function to get the external
+            * third party cloud storage accounts that the tenant supports
+            * @param excludeAddedProviders: return a list of support third party
+            * cloud storages that hasn't been added yet.
+            */
+        export function getExternalProviders(excludeAddedProviders?: boolean): Promise<IExternalProvider[]>;
+        /**
+            * @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;
+        export {};
 }
 
 /**
@@ -2723,7 +2812,7 @@ export namespace dialog {
             * @param dialogInfo - An object containing the parameters of the dialog module
             * @param submitHandler - Handler to call when the task module is completed
             */
-        function open(dialogInfo: DialogInfo, submitHandler?: (err: string, result: string) => void): IAppWindow;
+        function open(dialogInfo: DialogInfo, submitHandler?: (err: string, result: string | object) => void): IAppWindow;
         /**
             * Update height/width dialog info properties.
             *
@@ -4625,7 +4714,7 @@ export namespace tasks {
             * @param taskInfo - An object containing the parameters of the task module
             * @param submitHandler - Handler to call when the task module is completed
             */
-        function startTask(taskInfo: TaskInfo, submitHandler?: (err: string, result: string) => void): IAppWindow;
+        function startTask(taskInfo: TaskInfo, submitHandler?: (err: string, result: string | object) => void): IAppWindow;
         /**
             * @deprecated
             * As of 2.0.0-beta.1, please use {@link dialog.resize dialog.resize(dialogInfo: DialogInfo): void} instead.
@@ -4647,24 +4736,3 @@ export namespace tasks {
         function submitTask(result?: string | object, appIds?: string | string[]): void;
 }
 
-/**
-    * @deprecated
-    * As of 2.0.0-beta.1.
-    */
-/**
-    * @deprecated
-    * As of 2.0.0-beta.1.
-    */
-/**
-    * @deprecated
-    * As of 2.0.0-beta.1.
-    */
-/**
-    * @deprecated
-    * As of 2.0.0-beta.1.
-    */
-/**
-    * @deprecated
-    * As of 2.0.0-beta.1.
-    */
-

package/dist/MicrosoftTeams.js

@@ -395,7 +395,7 @@ __webpack_require__.d(__webpack_exports__, {
 });
 
 ;// CONCATENATED MODULE: ./src/internal/constants.ts
-var version = '2.0.0-beta.2';
+var version = '2.0.0-beta.3-dev.2';
 /**
  * @hidden
  * The SDK version when all SDK APIs started to check platform compatibility for the APIs was 1.6.0.
@@ -803,7 +803,8 @@ function ensureInitialized() {
             }
         }
         if (!found) {
-            throw new Error("This call is not allowed in the '" + GlobalVars.frameContext + "' context");
+            throw new Error("This call is only allowed in following contexts: " + JSON.stringify(expectedFrameContexts) + ". " +
+                ("Current context: \"" + GlobalVars.frameContext + "\"."));
         }
     }
 }
@@ -5244,6 +5245,7 @@ var settings;
 })(settings || (settings = {}));
 
 ;// CONCATENATED MODULE: ./src/public/tasks.ts
+/* eslint-disable @typescript-eslint/ban-types */
 
 
 /**
@@ -5290,7 +5292,6 @@ var tasks;
      * @param result - Contains the result to be sent to the bot or the app. Typically a JSON object or a serialized version of it
      * @param appIds - Helps to validate that the call originates from the same appId as the one that invoked the task module
      */
-    // eslint-disable-next-line
     function submitTask(result, appIds) {
         dialog.submit(result, appIds);
     }
@@ -5346,30 +5347,10 @@ var tasks;
 
 
 
-/**
- * @deprecated
- * As of 2.0.0-beta.1.
- */
 
-/**
- * @deprecated
- * As of 2.0.0-beta.1.
- */
 
-/**
- * @deprecated
- * As of 2.0.0-beta.1.
- */
 
-/**
- * @deprecated
- * As of 2.0.0-beta.1.
- */
 
-/**
- * @deprecated
- * As of 2.0.0-beta.1.
- */
 
 
 ;// CONCATENATED MODULE: ./src/private/files.ts
@@ -5400,19 +5381,47 @@ var files;
         CloudStorageProvider["Sharefile"] = "SHAREFILE";
         CloudStorageProvider["GoogleDrive"] = "GOOGLEDRIVE";
         CloudStorageProvider["Egnyte"] = "EGNYTE";
+        CloudStorageProvider["SharePoint"] = "SharePoint";
     })(CloudStorageProvider = files.CloudStorageProvider || (files.CloudStorageProvider = {}));
     /**
      * @hidden
      * Hide from docs
-     * ------
-     * Cloud storage provider integration type
+     *
+     * Cloud storage provider type enums
      */
     var CloudStorageProviderType;
     (function (CloudStorageProviderType) {
         CloudStorageProviderType[CloudStorageProviderType["Sharepoint"] = 0] = "Sharepoint";
         CloudStorageProviderType[CloudStorageProviderType["WopiIntegration"] = 1] = "WopiIntegration";
         CloudStorageProviderType[CloudStorageProviderType["Google"] = 2] = "Google";
+        CloudStorageProviderType[CloudStorageProviderType["OneDrive"] = 3] = "OneDrive";
+        CloudStorageProviderType[CloudStorageProviderType["Recent"] = 4] = "Recent";
+        CloudStorageProviderType[CloudStorageProviderType["Aggregate"] = 5] = "Aggregate";
+        CloudStorageProviderType[CloudStorageProviderType["FileSystem"] = 6] = "FileSystem";
+        CloudStorageProviderType[CloudStorageProviderType["Search"] = 7] = "Search";
+        CloudStorageProviderType[CloudStorageProviderType["AllFiles"] = 8] = "AllFiles";
+        CloudStorageProviderType[CloudStorageProviderType["SharedWithMe"] = 9] = "SharedWithMe";
     })(CloudStorageProviderType = files.CloudStorageProviderType || (files.CloudStorageProviderType = {}));
+    /**
+     * @hidden
+     * Hide from docs
+     *
+     * Special Document Library enum
+     */
+    var SpecialDocumentLibraryType;
+    (function (SpecialDocumentLibraryType) {
+        SpecialDocumentLibraryType["ClassMaterials"] = "classMaterials";
+    })(SpecialDocumentLibraryType = files.SpecialDocumentLibraryType || (files.SpecialDocumentLibraryType = {}));
+    /**
+     * @hidden
+     * Hide from docs
+     *
+     * Document Library Access enum
+     */
+    var DocumentLibraryAccessType;
+    (function (DocumentLibraryAccessType) {
+        DocumentLibraryAccessType["Readonly"] = "readonly";
+    })(DocumentLibraryAccessType = files.DocumentLibraryAccessType || (files.DocumentLibraryAccessType = {}));
     /**
      * @hidden
      * Hide from docs
@@ -5424,7 +5433,7 @@ var files;
     function getCloudStorageFolders(channelId) {
         return new Promise(function (resolve) {
             ensureInitialized(FrameContexts.content);
-            if (!channelId || channelId.length == 0) {
+            if (!channelId || channelId.length === 0) {
                 throw new Error('[files.getCloudStorageFolders] channelId name cannot be null or empty');
             }
             resolve(sendAndHandleSdkError('files.getCloudStorageFolders', channelId));
@@ -5441,7 +5450,7 @@ var files;
     function addCloudStorageFolder(channelId) {
         return new Promise(function (resolve) {
             ensureInitialized(FrameContexts.content);
-            if (!channelId || channelId.length == 0) {
+            if (!channelId || channelId.length === 0) {
                 throw new Error('[files.addCloudStorageFolder] channelId name cannot be null or empty');
             }
             resolve(sendMessageToParentAsync('files.addCloudStorageFolder', [channelId]));
@@ -5550,6 +5559,46 @@ var files;
         sendMessageToParent('openFilePreview', params);
     }
     files.openFilePreview = openFilePreview;
+    /**
+     * @hidden
+     * Allow 1st party apps to call this function to get the external
+     * third party cloud storage accounts that the tenant supports
+     * @param excludeAddedProviders: return a list of support third party
+     * cloud storages that hasn't been added yet.
+     */
+    function getExternalProviders(excludeAddedProviders) {
+        if (excludeAddedProviders === void 0) { excludeAddedProviders = false; }
+        return new Promise(function (resolve) {
+            ensureInitialized(FrameContexts.content);
+            resolve(sendAndHandleSdkError('files.getExternalProviders', excludeAddedProviders));
+        });
+    }
+    files.getExternalProviders = getExternalProviders;
+    /**
+     * @hidden
+     * 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) {
+        if (isMove === void 0) { isMove = false; }
+        return new Promise(function (resolve) {
+            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');
+            }
+            resolve(sendAndHandleSdkError('files.copyMoveFiles', selectedFiles, providerCode, destinationFolder, destinationProviderCode, isMove));
+        });
+    }
+    files.copyMoveFiles = copyMoveFiles;
     function isSupported() {
         return runtime.supports.files ? true : false;
     }