@microsoft/teams-js 2.4.2-beta.1 → 2.5.0-beta.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.4.1/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.4.2/js/MicrosoftTeams.min.js) or point your package manager at them.
 
 ## Usage
 
@@ -45,13 +45,13 @@ Reference the SDK inside of your `.html` page using:
 ```html
 <!-- Microsoft Teams JavaScript API (via CDN) -->
 <script
-  src="https://res.cdn.office.net/teams-js/2.4.1/js/MicrosoftTeams.min.js"
-  integrity="sha384-f54aC8b3HUFudeEk+QUkv5RpZUpPr2g7TdP4+jnDAMoJSmt+PbMdUV+zGTYCQY1c"
+  src="https://res.cdn.office.net/teams-js/2.4.2/js/MicrosoftTeams.min.js"
+  integrity="sha384-M1BiuUWGXFEu6jscBr/dyRZl4uojmiT5eMSu50lpG3eUyacKjwXE0eWRa2ZIdOmQ"
   crossorigin="anonymous"
 ></script>
 
 <!-- Microsoft Teams JavaScript API (via npm) -->
-<script src="node_modules/@microsoft/teams-js@2.4.1/dist/MicrosoftTeams.min.js"></script>
+<script src="node_modules/@microsoft/teams-js@2.4.2/dist/MicrosoftTeams.min.js"></script>
 
 <!-- Microsoft Teams JavaScript API (via local) -->
 <script src="MicrosoftTeams.min.js"></script>
@@ -69,6 +69,10 @@ Stay tuned for examples coming soon.
 
 The [Teams Test App](https://aka.ms/teams-test-app) is used to validate the Teams client SDK APIs.
 
+## Troubleshooting
+
+If the CDN hash value on the npm page is out of date please refer to [here] (https://github.com/OfficeDev/microsoft-teams-library-js/blob/main/packages/teams-js/README.md) for an up to date version. If you notice this problem, please report that issue to us in [GitHub Issues] (https://github.com/OfficeDev/microsoft-teams-library-js/issues)
+
 ## Contributing
 
 Please be sure to check out the [Contributor's guide](../../CONTRIBUTING.md) for crucial steps.

package/dist/MicrosoftTeams.d.ts

@@ -2159,8 +2159,6 @@ export namespace videoEx {
     * Namespace to interact with the authentication-specific part of the SDK.
     *
     * This object is used for starting or completing authentication flows.
-    *
-    * @beta
     */
 export namespace authentication {
         function initialize(): void;
@@ -3437,8 +3435,6 @@ export enum DevicePermission {
 
 /**
     * Namespace to interact with app initialization and lifecycle.
-    *
-    * @beta
     */
 export namespace app {
         const Messages: {
@@ -4042,6 +4038,8 @@ 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>;
         /**
@@ -4052,8 +4050,17 @@ 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>;
+        /**
+            * Checks if chat capability is supported by the host
+            *
+            * @returns boolean to represent whether the chat capability is supported
+            *
+            * @beta
+            */
         function isSupported(): boolean;
 }
 export {};
@@ -4066,6 +4073,8 @@ export {};
 export namespace dialog {
         /**
             * Data Structure to represent the SDK response when dialog closes
+            *
+            * @beta
             */
         interface ISdkResponse {
                 /**
@@ -4080,7 +4089,16 @@ export namespace dialog {
                     */
                 result?: string | object;
         }
+        /**
+            * Handler used to receive and process messages sent between a dialog and the app that launched it
+            * @beta
+            */
         type PostMessageChannel = (message: any) => void;
+        /**
+            * Handler used for receiving results when a dialog closes, either the value passed by {@linkcode submit}
+            * or an error if the dialog was closed by the user.
+            * @beta
+            */
         type DialogSubmitHandler = (result: ISdkResponse) => void;
         /**
             * @hidden
@@ -4090,6 +4108,8 @@ export namespace dialog {
             * Function is called during app initialization
             * @internal
             * Limited to Microsoft-internal use
+            *
+            * @beta
             */
         function initialize(): void;
         /**
@@ -4103,13 +4123,19 @@ export namespace dialog {
             * @param messageFromChildHandler - Handler that triggers if dialog sends a message to the app.
             *
             * @returns a function that can be used to send messages to the dialog.
+            *
+            * @beta
             */
         function open(urlDialogInfo: UrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): void;
         /**
             * Submit the dialog module and close the dialog
             *
-            * @param result - The result to be sent to the bot or the app. Typically a JSON object or a serialized version of it
+            * @param result - The result to be sent to the bot or the app. Typically a JSON object or a serialized version of it,
+            *  If this function is called from a dialog while {@link M365ContentAction} is set in the context object by the host, result will be ignored
+            *
             * @param appIds - Valid application(s) that can receive the result of the submitted dialogs. Specifying this parameter helps prevent malicious apps from retrieving the dialog result. Multiple app IDs can be specified because a web app from a single underlying domain can power multiple apps across different environments and branding schemes.
+            *
+            * @beta
             */
         function submit(result?: string | object, appIds?: string | string[]): void;
         /**
@@ -4119,12 +4145,16 @@ export namespace dialog {
             * This function is only called from inside of a dialog
             *
             * @param message - The message to send to the parent
+            *
+            * @beta
             */
         function sendMessageToParentFromDialog(message: any): void;
         /**
             *  Send message to the dialog from the parent
             *
             * @param message - The message to send
+            *
+            * @beta
             */
         function sendMessageToDialog(message: any): void;
         /**
@@ -4134,33 +4164,45 @@ export namespace dialog {
             * This function is only called from inside of a dialog.
             *
             * @param listener - The listener that will be triggered.
+            *
+            * @beta
             */
         function registerOnMessageFromParent(listener: PostMessageChannel): void;
         /**
             * Checks if dialog module is supported by the host
             *
             * @returns boolean to represent whether dialog module is supported
+            *
+            * @beta
             */
         function isSupported(): boolean;
         /**
             * Namespace to update the dialog
+            *
+            * @beta
             */
         namespace update {
                 /**
                     * Update dimensions - height/width of a dialog.
                     *
                     * @param dimensions - An object containing width and height properties.
+                    *
+                    * @beta
                     */
                 function resize(dimensions: DialogSize): void;
                 /**
                     * Checks if dialog.update capability is supported by the host
                     *
                     * @returns boolean to represent whether dialog.update is supported
+                    *
+                    * @beta
                     */
                 function isSupported(): boolean;
         }
         /**
             * Namespace to open a dialog that sends results to the bot framework
+            *
+            * @beta
             */
         namespace bot {
                 /**
@@ -4171,12 +4213,16 @@ export namespace dialog {
                     * @param messageFromChildHandler - Handler that triggers if dialog sends a message to the app.
                     *
                     * @returns a function that can be used to send messages to the dialog.
+                    *
+                    * @beta
                     */
                 function open(botUrlDialogInfo: BotUrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): void;
                 /**
                     * Checks if dialog.bot capability is supported by the host
                     *
                     * @returns boolean to represent whether dialog.bot is supported
+                    *
+                    * @beta
                     */
                 function isSupported(): boolean;
         }
@@ -4187,6 +4233,8 @@ export namespace dialog {
             *
             * @internal
             * Limited to Microsoft-internal use
+            *
+            * @beta
             */
         function getDialogInfoFromUrlDialogInfo(urlDialogInfo: UrlDialogInfo): DialogInfo;
         /**
@@ -4196,6 +4244,8 @@ export namespace dialog {
             *
             * @internal
             * Limited to Microsoft-internal use
+            *
+            * @beta
             */
         function getDialogInfoFromBotUrlDialogInfo(botUrlDialogInfo: BotUrlDialogInfo): DialogInfo;
 }
@@ -4301,13 +4351,13 @@ export namespace geoLocation {
 
 /**
     * Navigation-specific part of the SDK.
-    *
-    * @beta
     */
 export namespace pages {
         /**
             * Return focus to the host. Will move focus forward or backward based on where the application container falls in
             * the F6/tab order in the host.
+            * On mobile hosts or hosts where there is no keyboard interaction or UI notion of "focus" this function has no
+            * effect and will be a no-op when called.
             * @param navigateForward - Determines the direction to focus in host.
             */
         function returnFocus(navigateForward?: boolean): void;
@@ -4315,6 +4365,8 @@ export namespace pages {
             * @hidden
             *
             * Registers a handler for specifying focus when it passes from the host to the application.
+            * On mobile hosts or hosts where there is no UI notion of "focus" the handler registered with
+            * this function will never be called.
             *
             * @param handler - The handler for placing focus within the application.
             *
@@ -4392,6 +4444,7 @@ export namespace pages {
         function navigateToApp(params: NavigateToAppParams): Promise<void>;
         /**
             * Shares a deep link that a user can use to navigate back to a specific state in this page.
+            * Please note that this method does yet work on mobile hosts.
             *
             * @param deepLinkParameters - ID and label for the link and fallback URL.
             */
@@ -4399,6 +4452,8 @@ export namespace pages {
         /**
             * Registers a handler for changes from or to full-screen view for a tab.
             * Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
+            * On hosts where there is no support for making an app full screen, the handler registered
+            * with this function will never be called.
             * @param handler - The handler to invoke when the user toggles full-screen view for a tab.
             */
         function registerFullScreenHandler(handler: (isFullScreen: boolean) => void): void;
@@ -5990,27 +6045,34 @@ export namespace profile {
             * Opens a profile card at a specified position to show profile information about a persona.
             * @param showProfileRequest The parameters to position the card and identify the target user.
             * @returns Promise that will be fulfilled when the operation has completed
+            *
+            * @beta
             */
         function showProfile(showProfileRequest: ShowProfileRequest): Promise<void>;
         /**
             * The type of modalities that are supported when showing a profile.
             * Can be provided as an optional hint with the request and will be
             * respected if the hosting M365 application supports it.
+            *
+            * @beta
             */
         type Modality = 'Card' | 'Expanded';
         /**
             * The type of the profile trigger.
             *  - MouseHover: The user hovered a target.
-            *  - MouseClick: The user clicked a target.
-            *  - KeyboardPress: The user initiated the show profile request with their keyboard.
+            *  - Press: The target was pressed with either a mouse click or keyboard key press.
             *  - AppRequest: The show profile request is happening programmatically, without direct user interaction.
+            *
+            * @beta
             */
-        type TriggerType = 'MouseHover' | 'MouseClick' | 'KeyboardPress' | 'AppRequest';
+        type TriggerType = 'MouseHover' | 'Press' | 'AppRequest';
         /**
             * The set of identifiers that are supported for resolving the persona.
             *
             * At least one is required, and if multiple are provided then only the highest
             * priority one will be used (AadObjectId > Upn > Smtp).
+            *
+            * @beta
             */
         type PersonaIdentifiers = {
                 /**
@@ -6033,6 +6095,8 @@ export namespace profile {
         };
         /**
             * The persona to show the profile for.
+            *
+            * @beta
             */
         interface Persona {
                 /**
@@ -6046,6 +6110,8 @@ export namespace profile {
         }
         /**
             * Input parameters provided to the showProfile API.
+            *
+            * @beta
             */
         interface ShowProfileRequest {
                 /**
@@ -6065,6 +6131,13 @@ export namespace profile {
                     */
                 triggerType: TriggerType;
         }
+        /**
+            * Checks if the profile capability is supported by the host
+            *
+            * @returns boolean to represent whether the profile capability is supported
+            *
+            * @beta
+            */
         function isSupported(): boolean;
 }