npm - @microsoft/teams-js - Versions diffs - 2.0.0-beta.4-dev.5 → 2.0.0-beta.4-dev.8 - Mend

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

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (6) hide show

package/dist/MicrosoftTeams.d.ts +225 -173
package/dist/MicrosoftTeams.js +186 -151
package/dist/MicrosoftTeams.js.map +1 -1
package/dist/MicrosoftTeams.min.js +1 -1
package/dist/MicrosoftTeams.min.js.map +1 -1
package/package.json +1 -1

package/dist/MicrosoftTeams.d.ts CHANGED Viewed

@@ -89,173 +89,6 @@ export namespace bot {
         export {};
 }
-/**
-    * @hidden
-    * Namespace to interact with the menu-specific part of the SDK.
-    * This object is used to show View Configuration, Action Menu and Navigation Bar Menu.
-    *
-    * Hide from docs until feature is complete
-    * @alpha
-    */
-export namespace menus {
-        /**
-            * @hidden
-            * Represents information about item in View Configuration.
-            */
-        interface ViewConfiguration {
-                /**
-                    * @hidden
-                    * Unique identifier of view.
-                    */
-                id: string;
-                /**
-                    * @hidden
-                    * Display title of the view.
-                    */
-                title: string;
-                /**
-                    * @hidden
-                    * Additional information for accessibility.
-                    */
-                contentDescription?: string;
-        }
-        /**
-            * Defines how a menu item should appear in the NavBar.
-            */
-        enum DisplayMode {
-                /**
-                    * Only place this item in the NavBar if there's room for it.
-                    * If there's no room, item is shown in the overflow menu.
-                    */
-                ifRoom = 0,
-                /**
-                    * Never place this item in the NavBar.
-                    * The item would always be shown in NavBar's overflow menu.
-                    */
-                overflowOnly = 1
-        }
-        /**
-            * @hidden
-            * Represents information about menu item for Action Menu and Navigation Bar Menu.
-            */
-        class MenuItem {
-                /**
-                    * @hidden
-                    * Unique identifier for the menu item.
-                    */
-                id: string;
-                /**
-                    * @hidden
-                    * Display title of the menu item.
-                    */
-                title: string;
-                /**
-                    * @hidden
-                    * Display icon of the menu item. The icon value must be a string having SVG icon content.
-                    */
-                icon: string;
-                /**
-                    * @hidden
-                    * Selected state display icon of the menu item. The icon value must be a string having SVG icon content.
-                    */
-                iconSelected?: string;
-                /**
-                    * @hidden
-                    * Additional information for accessibility.
-                    */
-                contentDescription?: string;
-                /**
-                    * @hidden
-                    * State of the menu item
-                    */
-                enabled: boolean;
-                /**
-                    * @hidden
-                    * Interface to show list of items on selection of menu item.
-                    */
-                viewData?: ViewData;
-                /**
-                    * @hidden
-                    * Whether the menu item is selected or not
-                    */
-                selected: boolean;
-                /**
-                    * The Display Mode of the menu item.
-                    * Default Behaviour would be DisplayMode.ifRoom if null.
-                    * Refer {@link DisplayMode}
-                    */
-                displayMode?: DisplayMode;
-        }
-        /**
-            * @hidden
-            * Represents information about view to show on Navigation Bar Menu item selection
-            */
-        interface ViewData {
-                /**
-                    * @hidden
-                    * Display header title of the item list.
-                    */
-                listTitle?: string;
-                /**
-                    * @hidden
-                    * Type of the menu item.
-                    */
-                listType: MenuListType;
-                /**
-                    * @hidden
-                    * Array of MenuItem. Icon value will be required for all items in the list.
-                    */
-                listItems: MenuItem[];
-        }
-        /**
-            * @hidden
-            * Represents information about type of list to display in Navigation Bar Menu.
-            */
-        enum MenuListType {
-                dropDown = "dropDown",
-                popOver = "popOver"
-        }
-        function initialize(): void;
-        /**
-            * @hidden
-            * Registers list of view configurations and it's handler.
-            * Handler is responsible for listening selection of View Configuration.
-            *
-            * @param viewConfig - List of view configurations. Minimum 1 value is required.
-            * @param handler - The handler to invoke when the user selects view configuration.
-            */
-        function setUpViews(viewConfig: ViewConfiguration[], handler: (id: string) => boolean): void;
-        /**
-            * @hidden
-            * Used to set menu items on the Navigation Bar. If icon is available, icon will be shown, otherwise title will be shown.
-            *
-            * @param items List of MenuItems for Navigation Bar Menu.
-            * @param handler The handler to invoke when the user selects menu item.
-            */
-        function setNavBarMenu(items: MenuItem[], handler: (id: string) => boolean): void;
-        interface ActionMenuParameters {
-                /**
-                    * @hidden
-                    * Display title for Action Menu
-                    */
-                title: string;
-                /**
-                    * @hidden
-                    * List of MenuItems for Action Menu
-                    */
-                items: MenuItem[];
-        }
-        /**
-            * @hidden
-            * Used to show Action Menu.
-            *
-            * @param params - Parameters for Menu Parameters
-            * @param handler - The handler to invoke when the user selects menu item.
-            */
-        function showActionMenu(params: ActionMenuParameters, handler: (id: string) => boolean): void;
-        function isSupported(): boolean;
-}
 /**
     * @hidden
     * Namespace to interact with the logging part of the SDK.
@@ -792,6 +625,53 @@ export namespace files {
                 remoteItem?: string;
                 listUrl?: string;
         }
+        /**
+            * @hidden
+            * Hide from docs
+            *
+            * Download status enum
+            */
+        export enum FileDownloadStatus {
+                Downloaded = "Downloaded",
+                Downloading = "Downloading",
+                Failed = "Failed"
+        }
+        /**
+            * @hidden
+            * Hide from docs
+            *
+            * Download Files interface
+            */
+        export interface IFileItem {
+                /**
+                    * ID of the file metadata
+                    */
+                objectId?: string;
+                /**
+                    * Path of the file
+                    */
+                path?: string;
+                /**
+                    * Size of the file in bytes
+                    */
+                sizeInBytes?: number;
+                /**
+                    * Download status
+                    */
+                status?: FileDownloadStatus;
+                /**
+                    * Download timestamp
+                    */
+                timestamp: Date;
+                /**
+                    * File name
+                    */
+                title: string;
+                /**
+                    * Type of file i.e. the file extension.
+                    */
+                extension: string;
+        }
         /**
             * @hidden
             * Hide from docs
@@ -864,6 +744,21 @@ export namespace files {
             */
         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(callback: (error?: SdkError, files?: IFileItem[]) => void): void;
+        /**
+            * @hidden
+            * Hide from docs
+            * ------
+            * Open download preference folder
+            */
+        export function openDownloadFolder(): void;
         export {};
 }
@@ -3219,6 +3114,169 @@ export class ParentAppWindow implements IAppWindow {
         addEventListener(type: string, listener: (message: any) => void): void;
 }
+/**
+    * Namespace to interact with the menu-specific part of the SDK.
+    * This object is used to show View Configuration, Action Menu and Navigation Bar Menu.
+    */
+export namespace menus {
+        /**
+            * @hidden
+            * Represents information about item in View Configuration.
+            */
+        interface ViewConfiguration {
+                /**
+                    * @hidden
+                    * Unique identifier of view.
+                    */
+                id: string;
+                /**
+                    * @hidden
+                    * Display title of the view.
+                    */
+                title: string;
+                /**
+                    * @hidden
+                    * Additional information for accessibility.
+                    */
+                contentDescription?: string;
+        }
+        /**
+            * Defines how a menu item should appear in the NavBar.
+            */
+        enum DisplayMode {
+                /**
+                    * Only place this item in the NavBar if there's room for it.
+                    * If there's no room, item is shown in the overflow menu.
+                    */
+                ifRoom = 0,
+                /**
+                    * Never place this item in the NavBar.
+                    * The item would always be shown in NavBar's overflow menu.
+                    */
+                overflowOnly = 1
+        }
+        /**
+            * @hidden
+            * Represents information about menu item for Action Menu and Navigation Bar Menu.
+            */
+        class MenuItem {
+                /**
+                    * @hidden
+                    * Unique identifier for the menu item.
+                    */
+                id: string;
+                /**
+                    * @hidden
+                    * Display title of the menu item.
+                    */
+                title: string;
+                /**
+                    * @hidden
+                    * Display icon of the menu item. The icon value must be a string having SVG icon content.
+                    */
+                icon: string;
+                /**
+                    * @hidden
+                    * Selected state display icon of the menu item. The icon value must be a string having SVG icon content.
+                    */
+                iconSelected?: string;
+                /**
+                    * @hidden
+                    * Additional information for accessibility.
+                    */
+                contentDescription?: string;
+                /**
+                    * @hidden
+                    * State of the menu item
+                    */
+                enabled: boolean;
+                /**
+                    * @hidden
+                    * Interface to show list of items on selection of menu item.
+                    */
+                viewData?: ViewData;
+                /**
+                    * @hidden
+                    * Whether the menu item is selected or not
+                    */
+                selected: boolean;
+                /**
+                    * The Display Mode of the menu item.
+                    * Default Behaviour would be DisplayMode.ifRoom if null.
+                    * Refer {@link DisplayMode}
+                    */
+                displayMode?: DisplayMode;
+        }
+        /**
+            * @hidden
+            * Represents information about view to show on Navigation Bar Menu item selection
+            */
+        interface ViewData {
+                /**
+                    * @hidden
+                    * Display header title of the item list.
+                    */
+                listTitle?: string;
+                /**
+                    * @hidden
+                    * Type of the menu item.
+                    */
+                listType: MenuListType;
+                /**
+                    * @hidden
+                    * Array of MenuItem. Icon value will be required for all items in the list.
+                    */
+                listItems: MenuItem[];
+        }
+        /**
+            * @hidden
+            * Represents information about type of list to display in Navigation Bar Menu.
+            */
+        enum MenuListType {
+                dropDown = "dropDown",
+                popOver = "popOver"
+        }
+        function initialize(): void;
+        /**
+            * @hidden
+            * Registers list of view configurations and it's handler.
+            * Handler is responsible for listening selection of View Configuration.
+            *
+            * @param viewConfig - List of view configurations. Minimum 1 value is required.
+            * @param handler - The handler to invoke when the user selects view configuration.
+            */
+        function setUpViews(viewConfig: ViewConfiguration[], handler: (id: string) => boolean): void;
+        /**
+            * @hidden
+            * Used to set menu items on the Navigation Bar. If icon is available, icon will be shown, otherwise title will be shown.
+            *
+            * @param items List of MenuItems for Navigation Bar Menu.
+            * @param handler The handler to invoke when the user selects menu item.
+            */
+        function setNavBarMenu(items: MenuItem[], handler: (id: string) => boolean): void;
+        interface ActionMenuParameters {
+                /**
+                    * @hidden
+                    * Display title for Action Menu
+                    */
+                title: string;
+                /**
+                    * @hidden
+                    * List of MenuItems for Action Menu
+                    */
+                items: MenuItem[];
+        }
+        /**
+            * @hidden
+            * Used to show Action Menu.
+            *
+            * @param params - Parameters for Menu Parameters
+            * @param handler - The handler to invoke when the user selects menu item.
+            */
+        function showActionMenu(params: ActionMenuParameters, handler: (id: string) => boolean): void;
+        function isSupported(): boolean;
+}
 /**
     * @alpha
     */
@@ -4444,28 +4502,22 @@ export namespace sharing {
                 preview?: boolean;
         }
         /**
-            * @hidden
             * Feature is under development
             * Opens a share dialog for web content
             *
             * @param shareWebContentRequest - web content info
             * @returns Promise that will be fulfilled when the operation has completed
-            *
-            * @internal
             */
         export function shareWebContent(shareWebContentRequest: IShareRequest<IShareRequestContentType>): Promise<void>;
         /**
             * @deprecated
             * As of 2.0.0-beta.3, please use {@link sharing.shareWebContent sharing.shareWebContent(shareWebContentRequest: IShareRequest\<IShareRequestContentType\>): Promise\<void\>} instead.
             *
-            * @hidden
             * Feature is under development
             * Opens a share dialog for web content
             *
             * @param shareWebContentRequest - web content info
             * @param callback - optional callback
-            *
-            * @internal
             */
         export function shareWebContent(shareWebContentRequest: IShareRequest<IShareRequestContentType>, callback: (err?: SdkError) => void): void;
         export function isSupported(): boolean;