@microsoft/teams-js 2.0.0-beta.1 → 2.0.0-beta.2-dev.0

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
  1. package/dist/MicrosoftTeams.d.ts +36 -65
  2. package/dist/MicrosoftTeams.js +3 -61
  3. package/dist/MicrosoftTeams.js.map +1 -1
  4. package/dist/MicrosoftTeams.min.js +1 -1
  5. package/dist/MicrosoftTeams.min.js.map +1 -1
  6. package/package.json +1 -27
package/dist/MicrosoftTeams.d.ts CHANGED
@@ -862,7 +862,7 @@ declare module '@microsoft/teams-js/private/meetingRoom' {
862
862
  * ------
863
863
  * Data structure to represent a meeting room.
864
864
  */
865
- interface MeetingRoomInfo {
865
+ export interface MeetingRoomInfo {
866
866
  /**
867
867
  * @hidden
868
868
  * Endpoint id of the meeting room.
@@ -888,82 +888,52 @@ declare module '@microsoft/teams-js/private/meetingRoom' {
888
888
  * @hidden
889
889
  * Hide from docs
890
890
  * ------
891
- * Enum used to indicate meeting room capabilities.
891
+ * Type of Media control capabilities of a meeting room.
892
892
  */
893
- enum Capability {
894
- /**
895
- * @hidden
896
- * Media control capability: toggle mute.
897
- */
898
- toggleMute = "toggleMute",
899
- /**
900
- * @hidden
901
- * Media control capability: toggle camera.
902
- */
903
- toggleCamera = "toggleCamera",
904
- /**
905
- * @hidden
906
- * Media control capability: toggle captions.
907
- */
908
- toggleCaptions = "toggleCaptions",
909
- /**
910
- * @hidden
911
- * Media control capability: volume ajustion.
912
- */
913
- volume = "volume",
914
- /**
915
- * @hidden
916
- * Stage layout control capability: show gallery mode.
917
- */
918
- showVideoGallery = "showVideoGallery",
919
- /**
920
- * @hidden
921
- * Stage layout control capability: show content mode.
922
- */
923
- showContent = "showContent",
924
- /**
925
- * @hidden
926
- * Stage layout control capability: show content + gallery mode.
927
- */
928
- showVideoGalleryAndContent = "showVideoGalleryAndContent",
929
- /**
930
- * @hidden
931
- * Stage layout control capability: show laryge gallery mode.
932
- */
933
- showLargeGallery = "showLargeGallery",
934
- /**
935
- * @hidden
936
- * Stage layout control capability: show together mode.
937
- */
938
- showTogether = "showTogether",
939
- /**
940
- * @hidden
941
- * Meeting control capability: leave meeting.
942
- */
943
- leaveMeeting = "leaveMeeting"
944
- }
893
+ type MediaControls = 'toggleMute' | 'toggleCamera' | 'toggleCaptions' | 'volume';
894
+ /**
895
+ * @hidden
896
+ * Hide from docs
897
+ * ------
898
+ * Types of Stage Layout control capabilities of a meeting room.
899
+ */
900
+ type StageLayoutControls = 'showVideoGallery' | 'showContent' | 'showContent' | 'showVideoGalleryAndContent' | 'showLargeGallery' | 'showTogether';
901
+ /**
902
+ * @hidden
903
+ * Hide from docs
904
+ * ------
905
+ * Types of Meeting Control capabilities of a meeting room.
906
+ */
907
+ type MeetingControls = 'leaveMeeting';
908
+ /**
909
+ * @hidden
910
+ * Hide from docs
911
+ * ------
912
+ * Types of Stage Layout State of a meeting room.
913
+ */
914
+ type StageLayoutStates = 'Gallery' | 'Content + gallery' | 'Content' | 'Large gallery' | 'Together mode';
945
915
  /**
946
916
  * @hidden
947
917
  * Hide from docs
948
918
  * ------
949
919
  * Data structure to represent capabilities of a meeting room.
950
920
  */
951
- interface MeetingRoomCapability {
921
+ export interface MeetingRoomCapability {
952
922
  /**
953
923
  * @hidden
954
924
  * Media control capabilities, value can be "toggleMute", "toggleCamera", "toggleCaptions", "volume".
955
925
  */
956
- mediaControls: string[];
926
+ mediaControls: MediaControls[];
957
927
  /**
958
928
  * @hidden
959
929
  * Main stage layout control capabilities, value can be "showVideoGallery", "showContent", "showVideoGalleryAndContent", "showLargeGallery", "showTogether".
960
930
  */
961
- stageLayoutControls: string[];
931
+ stageLayoutControls: StageLayoutControls[];
962
932
  /**
963
933
  * @hidden
964
934
  * Meeting control capabilities, value can be "leaveMeeting".
965
935
  */
966
- meetingControls: string[];
936
+ meetingControls: MeetingControls[];
967
937
  }
968
938
  /**
969
939
  * @hidden
@@ -971,7 +941,7 @@ declare module '@microsoft/teams-js/private/meetingRoom' {
971
941
  * ------
972
942
  * Data structure to represent states of a meeting room.
973
943
  */
974
- interface MeetingRoomState {
944
+ export interface MeetingRoomState {
975
945
  /**
976
946
  * @hidden
977
947
  * Current mute state, true: mute, false: unmute.
@@ -991,7 +961,7 @@ declare module '@microsoft/teams-js/private/meetingRoom' {
991
961
  * @hidden
992
962
  * Current main stage layout state, value can be one of "Gallery", "Content + gallery", "Content", "Large gallery" and "Together mode".
993
963
  */
994
- stageLayout: string;
964
+ stageLayout: StageLayoutStates;
995
965
  /**
996
966
  * @hidden
997
967
  * Current leaveMeeting state, true: leave, false: no-op.
@@ -1006,7 +976,7 @@ declare module '@microsoft/teams-js/private/meetingRoom' {
1006
976
  *
1007
977
  * @returns Promise resolved with meeting room info or rejected with SdkError value
1008
978
  */
1009
- function getPairedMeetingRoomInfo(): Promise<MeetingRoomInfo>;
979
+ export function getPairedMeetingRoomInfo(): Promise<MeetingRoomInfo>;
1010
980
  /**
1011
981
  * @hidden
1012
982
  * Hide from docs
@@ -1016,7 +986,7 @@ declare module '@microsoft/teams-js/private/meetingRoom' {
1016
986
  * @param commandName The command name.
1017
987
  * @returns Promise resolved upon completion or rejected with SdkError value
1018
988
  */
1019
- function sendCommandToPairedMeetingRoom(commandName: string): Promise<void>;
989
+ export function sendCommandToPairedMeetingRoom(commandName: string): Promise<void>;
1020
990
  /**
1021
991
  * @hidden
1022
992
  * Hide from docs
@@ -1026,7 +996,7 @@ declare module '@microsoft/teams-js/private/meetingRoom' {
1026
996
  *
1027
997
  * @param handler The handler to invoke when the capabilities of meeting room update.
1028
998
  */
1029
- function registerMeetingRoomCapabilitiesUpdateHandler(handler: (capabilities: MeetingRoomCapability) => void): void;
999
+ export function registerMeetingRoomCapabilitiesUpdateHandler(handler: (capabilities: MeetingRoomCapability) => void): void;
1030
1000
  /**
1031
1001
  * @hidden
1032
1002
  * Hide from docs
@@ -1035,8 +1005,9 @@ declare module '@microsoft/teams-js/private/meetingRoom' {
1035
1005
  *
1036
1006
  * @param handler The handler to invoke when the states of meeting room update.
1037
1007
  */
1038
- function registerMeetingRoomStatesUpdateHandler(handler: (states: MeetingRoomState) => void): void;
1039
- function isSupported(): boolean;
1008
+ export function registerMeetingRoomStatesUpdateHandler(handler: (states: MeetingRoomState) => void): void;
1009
+ export function isSupported(): boolean;
1010
+ export {};
1040
1011
  }
1041
1012
  }
1042
1013
 
package/dist/MicrosoftTeams.js CHANGED
@@ -394,7 +394,7 @@ __webpack_require__.d(__webpack_exports__, {
394
394
  });
395
395
 
396
396
  ;// CONCATENATED MODULE: ./src/internal/constants.ts
397
- var version = '2.0.0-beta.1';
397
+ var version = '2.0.0-beta.2-dev.0';
398
398
  /**
399
399
  * @hidden
400
400
  * The SDK version when all SDK APIs started to check platform compatibility for the APIs was 1.6.0.
@@ -802,7 +802,8 @@ function ensureInitialized() {
802
802
  }
803
803
  }
804
804
  if (!found) {
805
- throw new Error("This call is not allowed in the '" + GlobalVars.frameContext + "' context");
805
+ throw new Error("This call is only allowed in following contexts: " + JSON.stringify(expectedFrameContexts) + ". " +
806
+ ("Current context: \"" + GlobalVars.frameContext + "\"."));
806
807
  }
807
808
  }
808
809
  }
@@ -5578,65 +5579,6 @@ var legacy;
5578
5579
  */
5579
5580
  var meetingRoom;
5580
5581
  (function (meetingRoom) {
5581
- /**
5582
- * @hidden
5583
- * Hide from docs
5584
- * ------
5585
- * Enum used to indicate meeting room capabilities.
5586
- */
5587
- var Capability;
5588
- (function (Capability) {
5589
- /**
5590
- * @hidden
5591
- * Media control capability: toggle mute.
5592
- */
5593
- Capability["toggleMute"] = "toggleMute";
5594
- /**
5595
- * @hidden
5596
- * Media control capability: toggle camera.
5597
- */
5598
- Capability["toggleCamera"] = "toggleCamera";
5599
- /**
5600
- * @hidden
5601
- * Media control capability: toggle captions.
5602
- */
5603
- Capability["toggleCaptions"] = "toggleCaptions";
5604
- /**
5605
- * @hidden
5606
- * Media control capability: volume ajustion.
5607
- */
5608
- Capability["volume"] = "volume";
5609
- /**
5610
- * @hidden
5611
- * Stage layout control capability: show gallery mode.
5612
- */
5613
- Capability["showVideoGallery"] = "showVideoGallery";
5614
- /**
5615
- * @hidden
5616
- * Stage layout control capability: show content mode.
5617
- */
5618
- Capability["showContent"] = "showContent";
5619
- /**
5620
- * @hidden
5621
- * Stage layout control capability: show content + gallery mode.
5622
- */
5623
- Capability["showVideoGalleryAndContent"] = "showVideoGalleryAndContent";
5624
- /**
5625
- * @hidden
5626
- * Stage layout control capability: show laryge gallery mode.
5627
- */
5628
- Capability["showLargeGallery"] = "showLargeGallery";
5629
- /**
5630
- * @hidden
5631
- * Stage layout control capability: show together mode.
5632
- */
5633
- Capability["showTogether"] = "showTogether";
5634
- /**
5635
- * @hidden
5636
- * Meeting control capability: leave meeting.
5637
- */
5638
- Capability["leaveMeeting"] = "leaveMeeting";
5639
- })(Capability = meetingRoom.Capability || (meetingRoom.Capability = {}));
5640
5582
  /**
5641
5583
  * @hidden
5642
5584
  * Hide from docs