@microsoft/teams-js 2.17.0-beta.1 → 2.17.0

package/README.md

@@ -24,7 +24,7 @@ To install the stable [version](https://learn.microsoft.com/javascript/api/overv
 
 ### Production
 
-You can reference these files directly [from here](https://res.cdn.office.net/teams-js/2.16.0/js/MicrosoftTeams.min.js) or point your package manager at them.
+You can reference these files directly [from here](https://res.cdn.office.net/teams-js/2.17.0/js/MicrosoftTeams.min.js) or point your package manager at them.
 
 ## Usage
 
@@ -45,13 +45,13 @@ Reference the library inside of your `.html` page using:
 ```html
 <!-- Microsoft Teams JavaScript API (via CDN) -->
 <script
-  src="https://res.cdn.office.net/teams-js/2.16.0/js/MicrosoftTeams.min.js"
-  integrity="sha384-v6djPeImSC5Pb0IvhWyq/XY8It8EYt0U00nPlcodpX/RN5KgChhoqkKEZs5kX5hr"
+  src="https://res.cdn.office.net/teams-js/2.17.0/js/MicrosoftTeams.min.js"
+  integrity="sha384-xp55t/129OsN192JZYLP0rGhzjCF9aYtjY0LVtXvolkDrBe4Jchylp56NrUYJ4S2"
   crossorigin="anonymous"
 ></script>
 
 <!-- Microsoft Teams JavaScript API (via npm) -->
-<script src="node_modules/@microsoft/teams-js@2.16.0/dist/MicrosoftTeams.min.js"></script>
+<script src="node_modules/@microsoft/teams-js@2.17.0/dist/MicrosoftTeams.min.js"></script>
 
 <!-- Microsoft Teams JavaScript API (via local) -->
 <script src="MicrosoftTeams.min.js"></script>

package/dist/MicrosoftTeams.d.ts

@@ -2819,6 +2819,20 @@ export const minAdaptiveCardVersion: AdaptiveCardVersion;
     * Adaptive Card version supported by the Teams v1 client.
     */
 export const teamsMinAdaptiveCardVersion: HostVersionsInfo;
+/**
+    * @hidden
+    * An error object indicates that the image count from visualMedia.image API is invalid.
+    *
+    * @beta
+    */
+export const errorInvalidCount: Error;
+/**
+    * @hidden
+    * An error object indicates that the response from the visualMedia.image API is invalid.
+    *
+    * @beta
+    */
+export const errorInvalidResponse: Error;
 
 /**
     * Represents information about tabs for an app
@@ -6036,14 +6050,18 @@ export namespace media {
 }
 
 /**
-    * Namespace to power up the in-app browser experiences in the Host App.
-    * For e.g., opening a URL in the Host App inside a browser
+    * Namespace to power up the in-app browser experiences in the host app.
+    * For e.g., opening a URL in the host app inside a browser
     *
     * @beta
     */
 export namespace secondaryBrowser {
         /**
-            * Open a URL in the secondary browser aka in-app browser
+            * Open a URL in the secondary browser.
+            *
+            * On mobile, this is the in-app browser.
+            *
+            * On web and desktop, please use the `window.open()` method or other native external browser methods.
             *
             * @param url Url to open in the browser
             * @returns Promise that successfully resolves if the URL  opens in the secondaryBrowser
@@ -7796,6 +7814,199 @@ export namespace stageView {
   */
 export const version = "ERROR: This value should be replaced by webpack!";
 
+/**
+    * @hidden
+    * Interact with images. Allows the app developer ask the user to get images from their camera / camera roll / file system.
+    *
+    * @beta
+    */
+export namespace visualMedia {
+        /**
+            * @hidden
+            * All properties common to Image and Video Props
+            *
+            * @beta
+            */
+        interface VisualMediaProps {
+                /**
+                    * @hidden
+                    * The maximum number of media items that can be selected at once is limited to values that are less than or equal to the maximum visual media selection limit.
+                    */
+                maxVisualMediaCount: number;
+        }
+        /**
+            * @hidden
+            * The required value of the visualMedia files from gallery
+            *
+            * @beta
+            */
+        export interface GalleryProps {
+                /**
+                    * The visualMedia source
+                    */
+                source: Source.Gallery;
+        }
+        /**
+            * @hidden
+            * The required value of the visualMedia files from camera
+            *
+            * @beta
+            */
+        export interface CameraProps {
+                /**
+                    * @hidden
+                    * The visualMedia source
+                    */
+                source: Source.Camera;
+                /**
+                    * @hidden
+                    * Optional; Specify whether users have the option to switch between the front and rear cameras. The default setting is FrontOrRear.
+                    * Default value is FrontOrRear
+                    */
+                cameraRestriction?: CameraRestriction;
+        }
+        /**
+            * @hidden
+            * Indicate if user is allowed to move between front and back camera or stay in front/back camera only
+            * If the camera option requested by the app isn't available, the SDK will silently default to the platform's standard camera.
+            *
+            * @beta
+            */
+        export enum CameraRestriction {
+                /** User can move between front and back camera */
+                FrontOrRear = 1,
+                /** User can only use the front camera */
+                FrontOnly = 2,
+                /** User can only use the back camera */
+                RearOnly = 3
+        }
+        /**
+            * @hidden
+            * Specifies the image source
+            *
+            * @beta
+            */
+        export enum Source {
+                /** The camera is the source of visual media. */
+                Camera = 1,
+                /** The source of visual media is the gallery. */
+                Gallery = 2
+        }
+        /**
+            * @hidden
+            * VisualMediaFile object that can be used to represent image or video from host apps.
+            *
+            * @beta
+            */
+        export interface VisualMediaFile {
+                /**
+                    * @hidden
+                    * This is the base64 content of file.
+                    * If app needs to use this directly in HTML tags, it should convert this to a data url.
+                    */
+                content: string;
+                /**
+                    * @hidden
+                    * The size of file represented in VisualMediaFile in KB
+                    */
+                sizeInKB: number;
+                /**
+                    * @hidden
+                    * Name of the file (does not include the extension)
+                    */
+                name: string;
+                /**
+                    * @hidden
+                    * File's MIME type. More information on supported `mimeTypes`(https://docs.lens.xyz/docs/metadata-standards#supported-mime-types-for-imagesaudiovideos).
+                    */
+                mimeType: string;
+        }
+        /**
+            * @hidden
+            * Checks whether or not visualMedia has user permission
+            * @returns Promise that will resolve with true if the user had granted the app permission to media information(including Camera and Gallery permission), or with false otherwise,
+            * In case of an error, promise will reject with the error.
+            * @throws NOT_SUPPORTED_ON_PLATFORM Error if the DevicePermission.Media permission has not successfully granted.
+            *
+            * @beta
+            */
+        export function hasPermission(): Promise<boolean>;
+        /**
+            * @hidden
+            * Requests user permission for visualMedia
+            * @returns Promise that will resolve with true if the user consented permission for media(including Camera and Gallery permission), or with false otherwise,
+            * In case of an error, promise will reject with the error.
+            * @throws NOT_SUPPORTED_ON_PLATFORM Error if the DevicePermission.Media permission has not successfully granted.
+            *
+            * @beta
+            */
+        export function requestPermission(): Promise<boolean>;
+        /**
+            * @hidden
+            * To enable this image capability will let the app developer ask the user to get images from camera/local storage
+            *
+            * @beta
+            */
+        export namespace image {
+                /**
+                    * @hidden
+                    * CameraImageProperties is for the image taken from the camera
+                    *
+                    * @beta
+                    */
+                interface CameraImageProperties extends VisualMediaProps {
+                        /**
+                            * @hidden
+                            * The source in CameraImageProperties should always be CameraProps
+                            */
+                        sourceProps: CameraProps;
+                }
+                /**
+                    * @hidden
+                    * CameraImageProperties is for the image taken from the camera
+                    *
+                    * @beta
+                    */
+                interface GalleryImageProperties extends VisualMediaProps {
+                        /**
+                            * @hidden
+                            * The source in GalleryImageProperties should always be GalleryProps
+                            */
+                        sourceProps: GalleryProps;
+                }
+                /**
+                    * @hidden
+                    * Capture one or multiple image(s) using camera.
+                    * @param cameraImageInputs - The input params to customize the image(s) to be captured
+                    * @returns Promise that will resolve with {@link VisualMediaFile[]} object or reject with an error.
+                    * @throws INVALID_ARGUMENTS Error if imageInputs is null or imageInputs.maxVisualMediaCount is greater than maxVisualMediaSelectionLimit or lesser than 1.
+                    *
+                    * @beta
+                    */
+                function captureImages(cameraImageInputs: CameraImageProperties): Promise<VisualMediaFile[]>;
+                /**
+                    * @hidden
+                    * Upload the existing image(s) from the gallery.
+                    * @param galleryImageInputs - The input params to customize the image(s) to be captured
+                    * @returns Promise that will resolve with {@link VisualMediaFile[]} object or reject with an error.
+                    * @throws INVALID_ARGUMENTS Error if imageInputs is null or imageInputs.maxVisualMediaCount is greater than maxVisualMediaSelectionLimit or lesser than 1.
+                    *
+                    * @beta
+                    */
+                function retrieveImages(galleryImageInputs: GalleryImageProperties): Promise<VisualMediaFile[]>;
+                /**
+                    * @hidden
+                    * Checks if visualMedia.image capability is supported by the host
+                    * @returns boolean to represent whether visualMedia.image is supported
+                    * @throws Error if {@linkcode app.initialize} has not successfully completed
+                    *
+                    * @beta
+                    */
+                function isSupported(): boolean;
+        }
+        export {};
+}
+
 /**
     * Contains functionality to allow web apps to store data in webview cache
     *
@@ -8305,7 +8516,13 @@ export namespace settings {
     * The tasks namespace will be deprecated. Please use dialog for future developments.
     */
 export namespace tasks {
-        /** Start task submit handler function type.  */
+        /**
+            * Function type that is used to receive the result when a task module is submitted by
+            * calling {@link tasks.submitTask tasks.submitTask(result?: string | object, appIds?: string | string[]): void}
+            *
+            * @param err - If the task module failed, this string contains the reason for failure. If the task module succeeded, this value is the empty string.
+            * @param result - On success, this is the value passed to the `result` parameter of {@link tasks.submitTask tasks.submitTask(result?: string | object, appIds?: string | string[]): void}. On failure, this is the empty string.
+            */
         type startTaskSubmitHandlerFunctionType = (err: string, result: string | object) => void;
         /**
             * @deprecated