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

package/dist/MicrosoftTeams.d.ts

@@ -3409,10 +3409,6 @@ export namespace menus {
         function isSupported(): boolean;
 }
 
-/**
-    * @deprecated
-    * As of 2.0.0-beta.6, use media only for backwards compatibility of existing code.
-    */
 export namespace media {
         /**
             * Enum for file formats supported
@@ -3449,9 +3445,6 @@ export namespace media {
                 name?: string;
         }
         /**
-            * @deprecated
-            * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
-            *
             * Launch camera, capture image or choose image from gallery and return the images as a File[] object to the callback.
             *
             * @params callback - Callback will be called with an @see SdkError if there are any.
@@ -3737,9 +3730,6 @@ export namespace media {
                 file: Blob;
         }
         /**
-            * @deprecated
-            * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
-            *
             * Select an attachment using camera/gallery
             *
             * @param mediaInputs - The input params to customize the media to be selected
@@ -3747,10 +3737,8 @@ export namespace media {
             */
         export function selectMedia(mediaInputs: MediaInputs, callback: (error: SdkError, attachments: Media[]) => void): void;
         /**
-            * @deprecated
-            * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
-            *
             * View images using native image viewer
+            *
             * @param uriList - list of URIs for images to be viewed - can be content URI or server URL. Supports up to 10 Images in a single call
             * @param callback - returns back error if encountered, returns null in case of success
             */
@@ -3767,10 +3755,8 @@ export namespace media {
                 timeOutIntervalInSec?: number;
         }
         /**
-            * @deprecated
-            * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
-            *
             * Scan Barcode/QRcode using camera
+            *
             * @remarks
             * Note: For desktop and web, this API is not supported. Callback will be resolved with ErrorCode.NotSupported.
             *
@@ -3848,10 +3834,6 @@ export namespace location {
         function isSupported(): boolean;
 }
 
-/**
-    * @deprecated
-    * As of 2.0.0-beta.6, use meeting only for backwards compatibility of existing code.
-    */
 export namespace meeting {
         /**
             * @hidden
@@ -4002,9 +3984,6 @@ export namespace meeting {
                 GroupCall = "groupCall"
         }
         /**
-            * @deprecated
-            * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
-            *
             * Allows an app to get the incoming audio speaker setting for the meeting user
             *
             * @param callback - Callback contains 2 parameters, error and result.
@@ -4015,9 +3994,6 @@ export namespace meeting {
             */
         function getIncomingClientAudioState(callback: (error: SdkError | null, result: boolean | null) => void): void;
         /**
-            * @deprecated
-            * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
-            *
             * Allows an app to toggle the incoming audio speaker setting for the meeting user from mute to unmute or vice-versa
             *
             * @param callback - Callback contains 2 parameters, error and result.
@@ -4027,9 +4003,6 @@ export namespace meeting {
             */
         function toggleIncomingClientAudio(callback: (error: SdkError | null, result: boolean | null) => void): void;
         /**
-            * @deprecated
-            * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
-            *
             * @hidden
             * Hide from docs
             *
@@ -4043,9 +4016,6 @@ export namespace meeting {
             */
         function getMeetingDetails(callback: (error: SdkError | null, meetingDetails: IMeetingDetailsResponse | null) => void): void;
         /**
-            * @deprecated
-            * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
-            *
             * @hidden
             * Allows an app to get the authentication token for the anonymous or guest user in the meeting
             *
@@ -4057,9 +4027,6 @@ export namespace meeting {
             */
         function getAuthenticationTokenForAnonymousUser(callback: (error: SdkError | null, authenticationTokenOfAnonymousUser: string | null) => void): void;
         /**
-            * @deprecated
-            * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
-            *
             * Allows an app to get the state of the live stream in the current meeting
             *
             * @param callback - Callback contains 2 parameters: error and liveStreamState.
@@ -4068,9 +4035,6 @@ export namespace meeting {
             */
         function getLiveStreamState(callback: (error: SdkError | null, liveStreamState: LiveStreamState | null) => void): void;
         /**
-            * @deprecated
-            * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
-            *
             * Allows an app to request the live streaming be started at the given streaming url
             *
             * @remarks
@@ -4082,9 +4046,6 @@ export namespace meeting {
             */
         function requestStartLiveStreaming(callback: (error: SdkError | null) => void, streamUrl: string, streamKey?: string): void;
         /**
-            * @deprecated
-            * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
-            *
             * Allows an app to request the live streaming be stopped at the given streaming url
             *
             * @remarks
@@ -4094,9 +4055,6 @@ export namespace meeting {
             */
         function requestStopLiveStreaming(callback: (error: SdkError | null) => void): void;
         /**
-            * @deprecated
-            * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
-            *
             * Registers a handler for changes to the live stream.
             *
             * @remarks
@@ -4106,9 +4064,6 @@ export namespace meeting {
             */
         function registerLiveStreamChangedHandler(handler: (liveStreamState: LiveStreamState) => void): void;
         /**
-            * @deprecated
-            * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
-            *
             * Allows an app to share contents in the meeting
             *
             * @param callback - Callback contains 2 parameters, error and result.
@@ -4118,9 +4073,6 @@ export namespace meeting {
             */
         function shareAppContentToStage(callback: (error: SdkError | null, result: boolean | null) => void, appContentUrl: string): void;
         /**
-            * @deprecated
-            * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
-            *
             * Provides information related app's in-meeting sharing capabilities
             *
             * @param callback - Callback contains 2 parameters, error and result.
@@ -4130,9 +4082,6 @@ export namespace meeting {
             */
         function getAppContentStageSharingCapabilities(callback: (error: SdkError | null, appContentStageSharingCapabilities: IAppContentStageSharingCapabilities | null) => void): void;
         /**
-            * @deprecated
-            * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
-            *
             * @hidden
             * Hide from docs.
             * Terminates current stage sharing session in meeting
@@ -4143,9 +4092,6 @@ export namespace meeting {
             */
         function stopSharingAppContentToStage(callback: (error: SdkError | null, result: boolean | null) => void): void;
         /**
-            * @deprecated
-            * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
-            *
             * Provides information related to current stage sharing state for app
             *
             * @param callback - Callback contains 2 parameters, error and result.
@@ -4155,9 +4101,6 @@ export namespace meeting {
             */
         function getAppContentStageSharingState(callback: (error: SdkError | null, appContentStageSharingState: IAppContentStageSharingState | null) => void): void;
         /**
-            * @deprecated
-            * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
-            *
             * Registers a handler for changes to paticipant speaking states. If any participant is speaking, isSpeakingDetected
             * will be true. If no participants are speaking, isSpeakingDetected will be false. Only one handler can be registered
             * at a time. A subsequent registration replaces an existing registration.

package/dist/MicrosoftTeams.js

@@ -1122,7 +1122,7 @@ __webpack_require__.d(__webpack_exports__, {
 });
 
 ;// CONCATENATED MODULE: ./src/internal/constants.ts
-var version = "2.0.0-beta.6-dev.15";
+var version = "2.0.0-beta.6-dev.18";
 /**
  * @hidden
  * The client version when all SDK APIs started to check platform compatibility for the APIs was 1.6.0.
@@ -2781,6 +2781,7 @@ var dialog;
 
 
 
+
 /**
  * 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.
@@ -2851,6 +2852,9 @@ var menus;
      */
     function setUpViews(viewConfig, handler) {
         ensureInitialized();
+        if (!isSupported()) {
+            throw errorNotSupportedOnPlatform;
+        }
         viewConfigItemPressHandler = handler;
         sendMessageToParent('setUpViews', [viewConfig]);
     }
@@ -2870,6 +2874,9 @@ var menus;
      */
     function setNavBarMenu(items, handler) {
         ensureInitialized();
+        if (!isSupported()) {
+            throw errorNotSupportedOnPlatform;
+        }
         navBarMenuItemPressHandler = handler;
         sendMessageToParent('setNavBarMenu', [items]);
     }
@@ -2889,6 +2896,9 @@ var menus;
      */
     function showActionMenu(params, handler) {
         ensureInitialized();
+        if (!isSupported()) {
+            throw errorNotSupportedOnPlatform;
+        }
         actionMenuItemPressHandler = handler;
         sendMessageToParent('showActionMenu', [params]);
     }
@@ -2910,6 +2920,7 @@ var menus;
  // Conflict with some names
 
 
+
 /**
  * Namespace containing the set of APIs that support Teams-specific functionalities.
  */
@@ -2920,8 +2931,11 @@ var teamsCore;
      */
     function enablePrintCapability() {
         if (!GlobalVars.printCapabilityEnabled) {
-            GlobalVars.printCapabilityEnabled = true;
             ensureInitialized();
+            if (!isSupported()) {
+                throw errorNotSupportedOnPlatform;
+            }
+            GlobalVars.printCapabilityEnabled = true;
             // adding ctrl+P and cmd+P handler
             document.addEventListener('keydown', function (event) {
                 if ((event.ctrlKey || event.metaKey) && event.keyCode === 80) {
@@ -2951,6 +2965,9 @@ var teamsCore;
      */
     function registerOnLoadHandler(handler) {
         ensureInitialized();
+        if (!isSupported()) {
+            throw errorNotSupportedOnPlatform;
+        }
         handlers_registerOnLoadHandler(handler);
     }
     teamsCore.registerOnLoadHandler = registerOnLoadHandler;
@@ -2965,6 +2982,9 @@ var teamsCore;
      */
     function registerBeforeUnloadHandler(handler) {
         ensureInitialized();
+        if (!isSupported()) {
+            throw errorNotSupportedOnPlatform;
+        }
         handlers_registerBeforeUnloadHandler(handler);
     }
     teamsCore.registerBeforeUnloadHandler = registerBeforeUnloadHandler;
@@ -5110,10 +5130,6 @@ var __extends = (undefined && undefined.__extends) || (function () {
 
 
 
-/**
- * @deprecated
- * As of 2.0.0-beta.6, use media only for backwards compatibility of existing code.
- */
 var media;
 (function (media) {
     /**
@@ -5134,9 +5150,6 @@ var media;
     }());
     media.File = File;
     /**
-     * @deprecated
-     * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
-     *
      * Launch camera, capture image or choose image from gallery and return the images as a File[] object to the callback.
      *
      * @params callback - Callback will be called with an @see SdkError if there are any.
@@ -5413,9 +5426,6 @@ var media;
         ImageOutputFormats[ImageOutputFormats["PDF"] = 2] = "PDF";
     })(ImageOutputFormats = media.ImageOutputFormats || (media.ImageOutputFormats = {}));
     /**
-     * @deprecated
-     * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
-     *
      * Select an attachment using camera/gallery
      *
      * @param mediaInputs - The input params to customize the media to be selected
@@ -5468,10 +5478,8 @@ var media;
     }
     media.selectMedia = selectMedia;
     /**
-     * @deprecated
-     * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
-     *
      * View images using native image viewer
+     *
      * @param uriList - list of URIs for images to be viewed - can be content URI or server URL. Supports up to 10 Images in a single call
      * @param callback - returns back error if encountered, returns null in case of success
      */
@@ -5495,10 +5503,8 @@ var media;
     }
     media.viewImages = viewImages;
     /**
-     * @deprecated
-     * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
-     *
      * Scan Barcode/QRcode using camera
+     *
      * @remarks
      * Note: For desktop and web, this API is not supported. Callback will be resolved with ErrorCode.NotSupported.
      *
@@ -5596,10 +5602,6 @@ var location_location;
 
 
 
-/**
- * @deprecated
- * As of 2.0.0-beta.6, use meeting only for backwards compatibility of existing code.
- */
 var meeting;
 (function (meeting) {
     var MeetingType;
@@ -5617,9 +5619,6 @@ var meeting;
         CallType["GroupCall"] = "groupCall";
     })(CallType = meeting.CallType || (meeting.CallType = {}));
     /**
-     * @deprecated
-     * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
-     *
      * Allows an app to get the incoming audio speaker setting for the meeting user
      *
      * @param callback - Callback contains 2 parameters, error and result.
@@ -5637,9 +5636,6 @@ var meeting;
     }
     meeting.getIncomingClientAudioState = getIncomingClientAudioState;
     /**
-     * @deprecated
-     * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
-     *
      * Allows an app to toggle the incoming audio speaker setting for the meeting user from mute to unmute or vice-versa
      *
      * @param callback - Callback contains 2 parameters, error and result.
@@ -5656,9 +5652,6 @@ var meeting;
     }
     meeting.toggleIncomingClientAudio = toggleIncomingClientAudio;
     /**
-     * @deprecated
-     * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
-     *
      * @hidden
      * Hide from docs
      *
@@ -5679,9 +5672,6 @@ var meeting;
     }
     meeting.getMeetingDetails = getMeetingDetails;
     /**
-     * @deprecated
-     * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
-     *
      * @hidden
      * Allows an app to get the authentication token for the anonymous or guest user in the meeting
      *
@@ -5700,9 +5690,6 @@ var meeting;
     }
     meeting.getAuthenticationTokenForAnonymousUser = getAuthenticationTokenForAnonymousUser;
     /**
-     * @deprecated
-     * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
-     *
      * Allows an app to get the state of the live stream in the current meeting
      *
      * @param callback - Callback contains 2 parameters: error and liveStreamState.
@@ -5718,9 +5705,6 @@ var meeting;
     }
     meeting.getLiveStreamState = getLiveStreamState;
     /**
-     * @deprecated
-     * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
-     *
      * Allows an app to request the live streaming be started at the given streaming url
      *
      * @remarks
@@ -5739,9 +5723,6 @@ var meeting;
     }
     meeting.requestStartLiveStreaming = requestStartLiveStreaming;
     /**
-     * @deprecated
-     * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
-     *
      * Allows an app to request the live streaming be stopped at the given streaming url
      *
      * @remarks
@@ -5758,9 +5739,6 @@ var meeting;
     }
     meeting.requestStopLiveStreaming = requestStopLiveStreaming;
     /**
-     * @deprecated
-     * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
-     *
      * Registers a handler for changes to the live stream.
      *
      * @remarks
@@ -5777,9 +5755,6 @@ var meeting;
     }
     meeting.registerLiveStreamChangedHandler = registerLiveStreamChangedHandler;
     /**
-     * @deprecated
-     * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
-     *
      * Allows an app to share contents in the meeting
      *
      * @param callback - Callback contains 2 parameters, error and result.
@@ -5796,9 +5771,6 @@ var meeting;
     }
     meeting.shareAppContentToStage = shareAppContentToStage;
     /**
-     * @deprecated
-     * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
-     *
      * Provides information related app's in-meeting sharing capabilities
      *
      * @param callback - Callback contains 2 parameters, error and result.
@@ -5815,9 +5787,6 @@ var meeting;
     }
     meeting.getAppContentStageSharingCapabilities = getAppContentStageSharingCapabilities;
     /**
-     * @deprecated
-     * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
-     *
      * @hidden
      * Hide from docs.
      * Terminates current stage sharing session in meeting
@@ -5835,9 +5804,6 @@ var meeting;
     }
     meeting.stopSharingAppContentToStage = stopSharingAppContentToStage;
     /**
-     * @deprecated
-     * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
-     *
      * Provides information related to current stage sharing state for app
      *
      * @param callback - Callback contains 2 parameters, error and result.
@@ -5854,9 +5820,6 @@ var meeting;
     }
     meeting.getAppContentStageSharingState = getAppContentStageSharingState;
     /**
-     * @deprecated
-     * As of 2.0.0-beta.6, use only for backwards compatibility of existing code.
-     *
      * Registers a handler for changes to paticipant speaking states. If any participant is speaking, isSpeakingDetected
      * will be true. If no participants are speaking, isSpeakingDetected will be false. Only one handler can be registered
      * at a time. A subsequent registration replaces an existing registration.
@@ -5902,6 +5865,9 @@ var monetization;
         }
         var wrappedFunction = function () {
             return new Promise(function (resolve) {
+                if (!isSupported()) {
+                    throw errorNotSupportedOnPlatform;
+                }
                 resolve(sendAndHandleSdkError('monetization.openPurchaseExperience', planInfo));
             });
         };
@@ -7865,6 +7831,9 @@ var teams;
      */
     function getTeamChannels(groupId, callback) {
         ensureInitialized(FrameContexts.content);
+        if (!isSupported()) {
+            throw errorNotSupportedOnPlatform;
+        }
         if (!groupId) {
             throw new Error('[teams.getTeamChannels] groupId cannot be null or empty');
         }
@@ -7884,6 +7853,9 @@ var teams;
      */
     function refreshSiteUrl(threadId, callback) {
         ensureInitialized();
+        if (!isSupported()) {
+            throw errorNotSupportedOnPlatform;
+        }
         if (!threadId) {
             throw new Error('[teams.refreshSiteUrl] threadId cannot be null or empty');
         }