@microsoft/teams-js 2.1.0-beta.4 → 2.1.0-beta.5

package/dist/MicrosoftTeams.d.ts

@@ -2570,6 +2570,11 @@ export enum ErrorCode {
             */
         SIZE_EXCEEDED = 10000
 }
+/** @hidden */
+export enum DevicePermission {
+        GeoLocation = "geolocation",
+        Media = "media"
+}
 
 /**
     * Namespace to interact with app initialization and lifecycle.
@@ -3063,6 +3068,49 @@ export namespace appInstallDialog {
     function isSupported(): boolean;
 }
 
+/**
+    * Namespace to interact with the barcode scanning-specific part of the SDK.
+    */
+export namespace barCode {
+        /**
+            * Data structure to customize the barcode scanning experience in scanBarCode API.
+            * All properties in BarCodeConfig are optional and have default values in the platform
+            */
+        interface BarCodeConfig {
+                /**
+                    * Optional; designates the scan timeout interval in seconds.
+                    * Default value is 30 seconds, max allowed value is 60 seconds.
+                    */
+                timeOutIntervalInSec?: number;
+        }
+        /**
+            * Scan Barcode or QRcode using camera
+            *
+            * @param barCodeConfig - input configuration to customize the barcode scanning experience
+            *
+            * @returns a scanned code
+            */
+        function scanBarCode(barCodeConfig: BarCodeConfig): Promise<string>;
+        /**
+            * Checks whether or not media has user permission
+            *
+            * @returns true if the user has granted the app permission to media information, false otherwise
+            */
+        function hasPermission(): Promise<boolean>;
+        /**
+            * Requests user permission for media
+            *
+            * @returns true if the user has granted the app permission to the media, false otherwise
+            */
+        function requestPermission(): Promise<boolean>;
+        /**
+            * Checks if barCode capability is supported by the host
+            *
+            * @returns boolean to represent whether barCode is supported
+            */
+        function isSupported(): boolean;
+}
+
 /**
     * Describes information needed to start a chat
     *
@@ -3272,6 +3320,103 @@ export namespace dialog {
         function getDialogInfoFromBotUrlDialogInfo(botUrlDialogInfo: BotUrlDialogInfo): DialogInfo;
 }
 
+/**
+    * Namespace to interact with the geoLocation module-specific part of the SDK. This is the newer version of location module.
+    *
+    * @beta
+    */
+export namespace geoLocation {
+        /**
+            * Data struture to represent the location information
+            *
+            * @beta
+            */
+        interface Location {
+                /**
+                    Latitude of the location
+                     */
+                latitude: number;
+                /**
+                    Longitude of the location
+                     */
+                longitude: number;
+                /**
+                    Accuracy of the coordinates captured
+                     */
+                accuracy?: number;
+                /**
+                    Time stamp when the location was captured
+                     */
+                timestamp?: number;
+        }
+        /**
+            * Fetches current user coordinates
+            * @returns Promise that will resolve with {@link geoLocation.Location} object or reject with an error. Function can also throw a NOT_SUPPORTED_ON_PLATFORM error
+            *
+            * @beta
+            */
+        function getCurrentLocation(): Promise<Location>;
+        /**
+            * Checks whether or not location has user permission
+            *
+            * @returns Promise that will resolve with true if the user had granted the app permission to location information, or with false otherwise,
+            * In case of an error, promise will reject with the error. Function can also throw a NOT_SUPPORTED_ON_PLATFORM error
+            *
+            * @beta
+            */
+        function hasPermission(): Promise<boolean>;
+        /**
+            * Requests user permission for location
+            *
+            * @returns true if the user consented permission for location, false otherwise
+            * @returns Promise that will resolve with true if the user consented permission for location, or with false otherwise,
+            * In case of an error, promise will reject with the error. Function can also throw a NOT_SUPPORTED_ON_PLATFORM error
+            *
+            * @beta
+            */
+        function requestPermission(): Promise<boolean>;
+        /**
+            * Checks if geoLocation capability is supported by the host
+            *
+            * @returns boolean to represent whether geoLocation is supported
+            *
+            * @beta
+            */
+        function isSupported(): boolean;
+        /**
+            * Namespace to interact with the location on map module-specific part of the SDK.
+            *
+            * @beta
+            */
+        namespace map {
+                /**
+                    * Allows user to choose location on map
+                    *
+                    * @returns Promise that will resolve with {@link geoLocation.Location} object chosen by the user or reject with an error. Function can also throw a NOT_SUPPORTED_ON_PLATFORM error
+                    *
+                    * @beta
+                    */
+                function chooseLocation(): Promise<Location>;
+                /**
+                    * Shows the location on map corresponding to the given coordinates
+                    *
+                    * @param location - Location to be shown on the map
+                    * @returns Promise that resolves when the location dialog has been closed or reject with an error. Function can also throw a NOT_SUPPORTED_ON_PLATFORM error
+                    *
+                    * @beta
+                    */
+                function showLocation(location: Location): Promise<void>;
+                /**
+                    * Checks if geoLocation.map capability is supported by the host
+                    *
+                    * @returns boolean to represent whether geoLocation.map is supported
+                    *
+                    * @beta
+                    */
+                function isSupported(): boolean;
+        }
+}
+
 /**
     * Navigation-specific part of the SDK.
     *
@@ -4180,6 +4325,9 @@ export namespace media {
                 timeOutIntervalInSec?: number;
         }
         /**
+            * @deprecated
+            * As of 2.1.0, please use {@link barCode.scanBarCode barCode.scanBarCode(config?: BarCodeConfig): Promise\<string\>} instead.
+    
             * Scan Barcode/QRcode using camera
             *
             * @remarks
@@ -4192,7 +4340,17 @@ export namespace media {
         export {};
 }
 
+/**
+    * @deprecated
+    * As of 2.1.0, please use geoLocation namespace.
+    *
+    * Namespace to interact with the location module-specific part of the SDK.
+    */
 export namespace location {
+        /**
+            * @deprecated
+            * Data Structure to set the location properties in getLocation call.
+            */
         interface LocationProps {
                 /**
                 whether user can alter location or not
@@ -4208,6 +4366,10 @@ export namespace location {
                  */
                 showMap?: boolean;
         }
+        /**
+            * @deprecated
+            * Data struture to represent the location information
+            */
         interface Location {
                 /**
                 Latitude of the location
@@ -4226,36 +4388,35 @@ export namespace location {
                  */
                 timestamp?: number;
         }
-        /**
-            * Fetches current user coordinates or allows user to choose location on map
-            *
-            * @param props {@link LocationProps} - Specifying how the location request is handled
-            * @returns Promise that will be fulfilled when the operation has completed
-            */
-        function getLocation(props: LocationProps): Promise<Location>;
         /**
             * @deprecated
-            * As of 2.0.0, please use {@link location.getLocation location.getLocation(props: LocationProps): Promise\<Location\>} instead.
+            * As of 2.1.0, please use one of the following functions:
+            * - {@link geoLocation.getCurrentLocation geoLocation.getCurrentLocation(): Promise\<Location\>} to get the current location.
+            * - {@link geoLocation.map.chooseLocation geoLocation.map.chooseLocation(): Promise\<Location\>} to choose location on map.
+            *
+            * Fetches user location
             * @param props {@link LocationProps} - Specifying how the location request is handled
             * @param callback - Callback to invoke when current user location is fetched
             */
         function getLocation(props: LocationProps, callback: (error: SdkError, location: Location) => void): void;
         /**
+            * @deprecated
+            * As of 2.1.0, please use {@link geoLocation.map.showLocation geoLocation.map.showLocation(location: Location): Promise\<void\>} instead.
+            *
             * Shows the location on map corresponding to the given coordinates
             *
-            * @param location {@link Location} - which needs to be shown on map
-            * @returns Promise that will be fulfilled when the operation has completed
+            * @param location - Location to be shown on the map
+            * @param callback - Callback to invoke when the location is opened on map
             */
-        function showLocation(location: Location): Promise<void>;
+        function showLocation(location: Location, callback: (error: SdkError, status: boolean) => void): void;
         /**
             * @deprecated
-            * As of 2.0.0, please use {@link location.showLocation location.showLocation(location: Location): Promise\<void\>} instead.
-            * Shows the location on map corresponding to the given coordinates
-            * @param location {@link Location} - which needs to be shown on map
-            * @param callback - Callback to invoke when the location is opened on map
+            * As of 2.1.0, please use geoLocation namespace, and use {@link geoLocation.isSupported geoLocation.isSupported: boolean} to check if geoLocation is supported.
+            *
+            * Checks if Location capability is supported by the host
+            *
+            * @returns boolean to represent whether Location is supported
             */
-        function showLocation(location: Location, callback: (error: SdkError, status: boolean) => void): void;
-        function showLocationHelper(location: Location): Promise<void>;
         function isSupported(): boolean;
 }
 
@@ -5061,6 +5222,8 @@ export namespace sharing {
 
 /**
     * Namespace to interact with the stage view specific part of the SDK.
+    *
+    *  @beta
     */
 export namespace stageView {
         /**
@@ -5097,10 +5260,18 @@ export namespace stageView {
             * Feature is under development
             *
             * Opens a stage view to display a Teams application
+            * @beta
             * @param stageViewParams - The parameters to pass into the stage view.
             * @returns Promise that resolves or rejects with an error once the stage view is closed.
             */
         function open(stageViewParams: StageViewParams): Promise<void>;
+        /**
+            * Checks if stageView capability is supported by the host
+            * @beta
+            * @returns true if the stageView capability is enabled in runtime.supports.stageView and
+            * false if it is disabled
+            */
+        function isSupported(): boolean;
 }
 
 /**