@microsoft/teams-js 2.20.1-beta.0 → 2.21.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.20.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.21.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.20.0/js/MicrosoftTeams.min.js"
-  integrity="sha384-wBC2cOp5ArjIyhxoK1NtXvJb98SbNojaoD6hXpvxWil+g4O1M2rXNtywEcAoQ8bl"
+  src="https://res.cdn.office.net/teams-js/2.21.0/js/MicrosoftTeams.min.js"
+  integrity="sha384-8IiFmUTxC/bV/D3X+IBPbfibh4oRJIbu7E14dqbrDjvMRs5JDg7p4sz0/JT74f2a"
   crossorigin="anonymous"
 ></script>
 
 <!-- Microsoft Teams JavaScript API (via npm) -->
-<script src="node_modules/@microsoft/teams-js@2.20.0/dist/MicrosoftTeams.min.js"></script>
+<script src="node_modules/@microsoft/teams-js@2.21.0/dist/MicrosoftTeams.min.js"></script>
 
 <!-- Microsoft Teams JavaScript API (via local) -->
 <script src="MicrosoftTeams.min.js"></script>

package/dist/MicrosoftTeams.d.ts

@@ -4824,8 +4824,6 @@ interface OpenChatRequest {
     * Used when starting a chat with one person
     *
     * @see OpenGroupChatRequest for use when a chat with more than one person
-    *
-    * @beta
     */
 export interface OpenSingleChatRequest extends OpenChatRequest {
         /**
@@ -4838,8 +4836,6 @@ export interface OpenSingleChatRequest extends OpenChatRequest {
     * Used when starting a chat with more than one person
     *
     * @see OpenSingleChatRequest for use in a chat with only one person
-    *
-    * @beta
     */
 export interface OpenGroupChatRequest extends OpenChatRequest {
         /**
@@ -4854,8 +4850,6 @@ export interface OpenGroupChatRequest extends OpenChatRequest {
 }
 /**
     * Contains functionality to start chat with others
-    *
-    * @beta
     */
 export namespace chat {
         /**
@@ -4865,8 +4859,6 @@ export namespace chat {
             * @param openChatRequest: {@link OpenSingleChatRequest}- a request object that contains a user's email as well as an optional message parameter.
             *
             * @returns Promise resolved upon completion
-            *
-            * @beta
             */
         function openChat(openChatRequest: OpenSingleChatRequest): Promise<void>;
         /**
@@ -4877,8 +4869,6 @@ export namespace chat {
             * @param openChatRequest: {@link OpenGroupChatRequest} - a request object that contains a list of user emails as well as optional parameters for message and topic (display name for the group chat).
             *
             * @returns Promise resolved upon completion
-            *
-            * @beta
             */
         function openGroupChat(openChatRequest: OpenGroupChatRequest): Promise<void>;
         /**
@@ -4886,8 +4876,6 @@ export namespace chat {
             * @returns boolean to represent whether the chat capability is supported
             *
             * @throws Error if {@linkcode app.initialize} has not successfully completed
-            *
-            * @beta
             */
         function isSupported(): boolean;
 }
@@ -7282,6 +7270,64 @@ export namespace meeting {
             * @beta
             */
         function registerMeetingReactionReceivedHandler(handler: (eventData: MeetingReactionReceivedEventData) => void): void;
+        /**
+            * @hidden
+            * Hide from docs beacuse it's only used internally as a serialization/deserialization type
+            *
+            * @internal
+            * Limited to Microsoft-internal use
+            */
+        interface ISerializedJoinMeetingParams {
+                joinWebUrl: string;
+                source: EventActionSource;
+        }
+        /**
+            * This function is used to join a meeting.
+            * This opens a meeting in a new window for the desktop app.
+            * In case of a web app, it will close the current app and open the meeting in the same tab.
+            * There is currently no support or experience for this on mobile platforms.
+            * @param joinMeetingParams This takes {@link JoinMeetingParams} for joining the meeting. If source isn't passed then it is marked as 'Other' by default.
+            * @throws error if the meeting join fails, the promise will reject to an object with the error message.
+            */
+        function joinMeeting(joinMeetingParams: JoinMeetingParams): Promise<void>;
+        /**
+            * Contains information associated with parameters required for joining the Microsoft Teams meetings.
+            * More details regarding parameters can be found at:
+            * [Online Meeting Base - Microsoft Graph v1.0](https://learn.microsoft.com/en-us/graph/api/resources/onlinemeetingbase?view=graph-rest-1.0)
+            */
+        interface JoinMeetingParams {
+                /** The join URL of the online meeting. */
+                joinWebUrl: URL;
+                /** The source of the join button click. If not passed, 'Other' is the default value of source. {@link EventActionSource} */
+                source?: EventActionSource;
+        }
+        /** The source of the join button click. */
+        enum EventActionSource {
+                /**
+                    * Source is calendar grid context menu.
+                    */
+                M365CalendarGridContextMenu = "m365_calendar_grid_context_menu",
+                /**
+                    * Source is calendar grid peek.
+                    */
+                M365CalendarGridPeek = "m365_calendar_grid_peek",
+                /**
+                    * Source is calendar grid event card join button.
+                    */
+                M365CalendarGridEventCardJoinButton = "m365_calendar_grid_event_card_join_button",
+                /**
+                    * Source is calendar form ribbon join button.
+                    */
+                M365CalendarFormRibbonJoinButton = "m365_calendar_form_ribbon_join_button",
+                /**
+                    * Source is calendar form join teams meeting button.
+                    */
+                M365CalendarFormJoinTeamsMeetingButton = "m365_calendar_form_join_teams_meeting_button",
+                /**
+                    * Other sources.
+                    */
+                Other = "other"
+        }
         /**
             * Nested namespace for functions to control behavior of the app share button
             *