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

package/README.md

@@ -50,7 +50,7 @@ Reference the SDK inside of your `.html` page using:
 <script src="https://statics.teams.cdn.office.net/sdk/v1.11.0/js/MicrosoftTeams.min.js" integrity="sha384-SCVF3m7OvDKnfAilUzYn2yozEvBeP8n/Oq0yTH8VUI70J4AzrqR70jzjdQ6DI8s2" crossorigin="anonymous"></script>
 
 <!-- Microsoft Teams JavaScript API (via npm) -->
-<script src="node_modules/@microsoft/teams-js@1.12.0-beta.4/dist/MicrosoftTeams.min.js"></script>
+<script src="node_modules/@microsoft/teams-js@1.11.0/dist/MicrosoftTeams.min.js"></script>
 
 <!-- Microsoft Teams JavaScript API (via local) -->
 <script src="MicrosoftTeams.min.js"></script>

package/dist/MicrosoftTeams.d.ts

@@ -25,7 +25,7 @@ declare namespace microsoftTeams {
    * instead of a response message to a child
    */
   export function sendMessageEventToChild(actionName: string, args?: any[]): void;
-  export const version = "1.12.0-beta.4";
+  export const version = "1.12.0-beta.5";
   /**
    * The client version when all SDK APIs started to check platform compatibility for the APIs was 1.6.0.
    * Modified to 2.0.1 which is hightest till now so that if any client doesn't pass version in initialize function, it will be set to highest.
@@ -1624,6 +1624,7 @@ declare namespace microsoftTeams {
       web = "web",
       android = "android",
       ios = "ios",
+      ipados = "ipados",
       /**
        * @deprecated Use teamsRoomsWindows instead.
        */
@@ -1958,7 +1959,7 @@ declare namespace microsoftTeams {
       isTeamArchived?: boolean;
       /**
        * The type of the host client. Possible values are : android, ios, web, desktop, rigel(deprecated, use teamsRoomsWindows instead),
-       * teamsRoomsWindows, teamsRoomsAndroid, teamsPhones, teamsDisplays
+       * surfaceHub, teamsRoomsWindows, teamsRoomsAndroid, teamsPhones, teamsDisplays
        */
       hostClientType?: HostClientType;
       /**
@@ -2637,13 +2638,13 @@ declare namespace microsoftTeams {
       /**
        * @private
        * Hide from docs
-       * Data structure to represent a meeting details.
+       * Data structure to represent a meeting details
        */
-      interface IMeetingDetails {
+      interface IMeetingDetailsResponse {
           /**
            * details object
            */
-          details: IDetails;
+          details: IMeetingDetails | ICallDetails;
           /**
            * conversation object
            */
@@ -2656,29 +2657,42 @@ declare namespace microsoftTeams {
       /**
        * @private
        * Hide from docs
-       * Data structure to represent details.
+       * Base data structure to represent a meeting or call detail
        */
-      interface IDetails {
+      interface IMeetingOrCallDetailsBase<T> {
           /**
-           * Scheduled start time of the meeting
+           * Scheduled start time of the meeting or start time of the call
            */
           scheduledStartTime: string;
           /**
-           * Scheduled end time of the meeting
+           * url to join the current meeting or call
            */
-          scheduledEndTime: string;
+          joinUrl?: string;
           /**
-           * url to join the current meeting
+           * type of the meeting or call
            */
-          joinUrl?: string;
+          type?: T;
+      }
+      /**
+       * @private
+       * Hide from docs
+       * Data structure to represent call details
+       */
+      type ICallDetails = IMeetingOrCallDetailsBase<CallType>;
+      /**
+       * @private
+       * Hide from docs
+       * Data structure to represent meeting details.
+       */
+      interface IMeetingDetails extends IMeetingOrCallDetailsBase<MeetingType> {
           /**
-           * meeting title name of the meeting
+           * Scheduled end time of the meeting
            */
-          title?: string;
+          scheduledEndTime: string;
           /**
-           * type of the meeting
+           * meeting title name of the meeting
            */
-          type?: MeetingType;
+          title?: string;
       }
       /**
        * @private
@@ -2733,6 +2747,13 @@ declare namespace microsoftTeams {
            */
           isAppSharing: boolean;
       }
+      interface ISpeakingState {
+          /**
+           * Indicates whether one or more participants in a meeting are speaking, or
+           * if no participants are speaking
+           */
+          isSpeakingDetected: boolean;
+      }
       enum MeetingType {
           Unknown = "Unknown",
           Adhoc = "Adhoc",
@@ -2741,6 +2762,10 @@ declare namespace microsoftTeams {
           Broadcast = "Broadcast",
           MeetNow = "MeetNow"
       }
+      enum CallType {
+          OneOnOneCall = "oneOnOneCall",
+          GroupCall = "groupCall"
+      }
       /**
        * Allows an app to get the incoming audio speaker setting for the meeting user
        * @param callback Callback contains 2 parameters, error and result.
@@ -2761,11 +2786,11 @@ declare namespace microsoftTeams {
        * @private
        * Hide from docs
        * Allows an app to get the meeting details for the meeting
-       * @param callback Callback contains 2 parameters, error and meetingDetails.
+       * @param callback Callback contains 2 parameters, error and meetingDetailsResponse.
        * error can either contain an error of type SdkError, incase of an error, or null when get is successful
-       * result can either contain a IMeetingDetails value, incase of a successful get or null when the get fails
+       * result can either contain a IMeetingDetailsResponse value, incase of a successful get or null when the get fails
        */
-      function getMeetingDetails(callback: (error: SdkError | null, meetingDetails: IMeetingDetails | null) => void): void;
+      function getMeetingDetails(callback: (error: SdkError | null, meetingDetails: IMeetingDetailsResponse | null) => void): void;
       /**
        * @private
        * Allows an app to get the authentication token for the anonymous or guest user in the meeting
@@ -2834,6 +2859,13 @@ declare namespace microsoftTeams {
        * (indication of successful retrieval), or null (indication of failed retrieval)
        */
       function getAppContentStageSharingState(callback: (error: SdkError | null, appContentStageSharingState: IAppContentStageSharingState | null) => void): void;
+      /**
+       * 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.
+       * @param handler The handler to invoke when the speaking state of any participant changes (start/stop speaking).
+       */
+      function registerSpeakingStateChangeHandler(handler: (speakingState: ISpeakingState) => void): void;
   }
   /**
    * Namespace to interact with the menu-specific part of the SDK.

package/dist/MicrosoftTeams.js

@@ -530,6 +530,7 @@ var HostClientType;
     HostClientType["web"] = "web";
     HostClientType["android"] = "android";
     HostClientType["ios"] = "ios";
+    HostClientType["ipados"] = "ipados";
     /**
      * @deprecated Use teamsRoomsWindows instead.
      */
@@ -726,7 +727,7 @@ function handleBeforeUnload() {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.userOriginUrlValidationRegExp = exports.validOriginRegExp = exports.validOrigins = exports.scanBarCodeAPIMobileSupportVersion = exports.getMediaCallbackSupportVersion = exports.mediaAPISupportVersion = exports.captureImageMobileSupportVersion = exports.peoplePickerRequiredVersion = exports.locationAPIsRequiredVersion = exports.getUserJoinedTeamsSupportedAndroidClientVersion = exports.imageOutputFormatsAPISupportVersion = exports.nonFullScreenVideoModeAPISupportVersion = exports.videoAndImageMediaAPISupportVersion = exports.defaultSDKVersionForCompatCheck = exports.version = void 0;
 var utils_1 = __webpack_require__(5);
-exports.version = '1.12.0-beta.4';
+exports.version = '1.12.0-beta.5';
 /**
  * The client version when all SDK APIs started to check platform compatibility for the APIs was 1.6.0.
  * Modified to 2.0.1 which is hightest till now so that if any client doesn't pass version in initialize function, it will be set to highest.
@@ -1722,7 +1723,7 @@ exports.exitFullscreen = exitFullscreen;
  * @param file The file to preview.
  */
 function openFilePreview(filePreviewParameters) {
-    (0, internalAPIs_1.ensureInitialized)(constants_1.FrameContexts.content);
+    (0, internalAPIs_1.ensureInitialized)(constants_1.FrameContexts.content, constants_1.FrameContexts.task);
     var params = [
         filePreviewParameters.entityId,
         filePreviewParameters.title,
@@ -3382,7 +3383,7 @@ var communication_1 = __webpack_require__(0);
  * @param navigateForward Determines the direction to focus in teams app.
  */
 function returnFocus(navigateForward) {
-    (0, internalAPIs_1.ensureInitialized)(constants_1.FrameContexts.content);
+    (0, internalAPIs_1.ensureInitialized)();
     (0, communication_1.sendMessageToParent)('returnFocus', [navigateForward]);
 }
 exports.returnFocus = returnFocus;
@@ -3577,6 +3578,11 @@ var meeting;
         MeetingType["Broadcast"] = "Broadcast";
         MeetingType["MeetNow"] = "MeetNow";
     })(MeetingType = meeting.MeetingType || (meeting.MeetingType = {}));
+    var CallType;
+    (function (CallType) {
+        CallType["OneOnOneCall"] = "oneOnOneCall";
+        CallType["GroupCall"] = "groupCall";
+    })(CallType = meeting.CallType || (meeting.CallType = {}));
     /**
      * Allows an app to get the incoming audio speaker setting for the meeting user
      * @param callback Callback contains 2 parameters, error and result.
@@ -3611,9 +3617,9 @@ var meeting;
      * @private
      * Hide from docs
      * Allows an app to get the meeting details for the meeting
-     * @param callback Callback contains 2 parameters, error and meetingDetails.
+     * @param callback Callback contains 2 parameters, error and meetingDetailsResponse.
      * error can either contain an error of type SdkError, incase of an error, or null when get is successful
-     * result can either contain a IMeetingDetails value, incase of a successful get or null when the get fails
+     * result can either contain a IMeetingDetailsResponse value, incase of a successful get or null when the get fails
      */
     function getMeetingDetails(callback) {
         if (!callback) {
@@ -3704,7 +3710,7 @@ var meeting;
         if (!callback) {
             throw new Error('[share app content to stage] Callback cannot be null');
         }
-        (0, internalAPIs_1.ensureInitialized)(constants_1.FrameContexts.sidePanel);
+        (0, internalAPIs_1.ensureInitialized)(constants_1.FrameContexts.sidePanel, constants_1.FrameContexts.meetingStage);
         (0, communication_1.sendMessageToParent)('meeting.shareAppContentToStage', [appContentUrl], callback);
     }
     meeting.shareAppContentToStage = shareAppContentToStage;
@@ -3719,7 +3725,7 @@ var meeting;
         if (!callback) {
             throw new Error('[get app content stage sharing capabilities] Callback cannot be null');
         }
-        (0, internalAPIs_1.ensureInitialized)(constants_1.FrameContexts.sidePanel);
+        (0, internalAPIs_1.ensureInitialized)(constants_1.FrameContexts.sidePanel, constants_1.FrameContexts.meetingStage);
         (0, communication_1.sendMessageToParent)('meeting.getAppContentStageSharingCapabilities', callback);
     }
     meeting.getAppContentStageSharingCapabilities = getAppContentStageSharingCapabilities;
@@ -3735,7 +3741,7 @@ var meeting;
         if (!callback) {
             throw new Error('[stop sharing app content to stage] Callback cannot be null');
         }
-        (0, internalAPIs_1.ensureInitialized)(constants_1.FrameContexts.sidePanel);
+        (0, internalAPIs_1.ensureInitialized)(constants_1.FrameContexts.sidePanel, constants_1.FrameContexts.meetingStage);
         (0, communication_1.sendMessageToParent)('meeting.stopSharingAppContentToStage', callback);
     }
     meeting.stopSharingAppContentToStage = stopSharingAppContentToStage;
@@ -3750,10 +3756,24 @@ var meeting;
         if (!callback) {
             throw new Error('[get app content stage sharing state] Callback cannot be null');
         }
-        (0, internalAPIs_1.ensureInitialized)(constants_1.FrameContexts.sidePanel);
+        (0, internalAPIs_1.ensureInitialized)(constants_1.FrameContexts.sidePanel, constants_1.FrameContexts.meetingStage);
         (0, communication_1.sendMessageToParent)('meeting.getAppContentStageSharingState', callback);
     }
     meeting.getAppContentStageSharingState = getAppContentStageSharingState;
+    /**
+     * 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.
+     * @param handler The handler to invoke when the speaking state of any participant changes (start/stop speaking).
+     */
+    function registerSpeakingStateChangeHandler(handler) {
+        if (!handler) {
+            throw new Error('[registerSpeakingStateChangeHandler] Handler cannot be null');
+        }
+        (0, internalAPIs_1.ensureInitialized)(constants_1.FrameContexts.sidePanel, constants_1.FrameContexts.meetingStage);
+        (0, handlers_1.registerHandler)('meeting.speakingStateChanged', handler);
+    }
+    meeting.registerSpeakingStateChangeHandler = registerSpeakingStateChangeHandler;
 })(meeting = exports.meeting || (exports.meeting = {}));