@microsoft/teams-js 2.15.0-beta.0 → 2.15.0-beta.2

package/dist/MicrosoftTeams.d.ts

@@ -2668,6 +2668,8 @@ export enum HostClientType {
         ios = "ios",
         /** Represents the iPadOS client of host, which runs on iOS devices such as iPads. */
         ipados = "ipados",
+        /** The host is running on a macOS client, which runs on devices such as MacBooks. */
+        macos = "macos",
         /**
             * @deprecated
             * As of 2.0.0, please use {@link teamsRoomsWindows} instead.
@@ -2941,7 +2943,7 @@ export interface TeamInformation {
     */
 export interface LocaleInfo {
         /** Represents the user's platform on which the app is running. */
-        platform: HostClientType.android | HostClientType.ios | 'macos' | 'windows';
+        platform: HostClientType.android | HostClientType.ios | HostClientType.macos | 'windows';
         /**
             * Represents the regional format used by the user's locale.
             * @example `en-us`.
@@ -3746,6 +3748,24 @@ export interface AdaptiveCardVersion {
         /** Represents the minor version number. */
         minorVersion: number;
 }
+/**
+    * Currently supported Mime type
+    */
+export enum ClipboardSupportedMimeType {
+        TextPlain = "text/plain",
+        TextHtml = "text/html",
+        ImagePNG = "image/png",
+        ImageJPEG = "image/jpeg"
+}
+/**
+    * Clipboard write parameters
+    */
+export interface ClipboardParams {
+        /** Mime Type of data to be copied to Clipboard */
+        mimeType: ClipboardSupportedMimeType;
+        /** Blob content in Base64 string format */
+        content: string;
+}
 
 /**
     * Namespace to interact with app initialization and lifecycle.
@@ -4285,97 +4305,6 @@ export namespace appInstallDialog {
         function isSupported(): boolean;
 }
 
-/**
-    * Namespace to interact with the appNotification specific part of the SDK
-    * @beta
-    */
-export namespace appNotification {
-        /**
-            * Data structure to represent appNotification information
-            *
-            * @beta
-            */
-        interface NotificationDisplayParam {
-                /**
-                    * Notification title(maximum length: 75 characters)
-                    */
-                title: string;
-                /**
-                    * Notification content (maximum length: 1500 characters)
-                    */
-                content: string;
-                /**
-                    * This would represent an optional icon that can be displayed on the notification. It should have a max size of 49 pixels by 49 pixels
-                    * If no icon is provided, the notification card would be displayed without an icon
-                    * The url link to where the icon is stored should be provided as the input string
-                    */
-                icon?: URL;
-                /**
-                    * This would specify how long a notification would be displayed on the screen for (unit: seconds)
-                    *
-                    */
-                displayDurationInSeconds: number;
-                /**
-                    * A url link to the page in which the notification would direct the user to.
-                    */
-                notificationActionUrl: URL;
-        }
-        /**
-            * @internal
-            *
-            * @hidden
-            *
-            * @beta
-            *
-            * Data structure to represent appNotification information that would be sent to the host SDK
-            */
-        interface NotificationDisplayParamForAppHost {
-                /**
-                    * Notification title(maximum length: 75 characters)
-                    */
-                title: string;
-                /**
-                    * Notification content (maximum length: 1500 characters)
-                    */
-                content: string;
-                /**
-                    * This would represent an optional icon that can be displayed on the notification. It should have a max size of 49 pixels by 49 pixels
-                    * If no icon is provided, the notification card would be displayed without an icon
-                    * The url link to where the icon is stored should be provided as the input string
-                    */
-                notificationIconAsString?: string;
-                /**
-                    * This would specify how long a notification would be displayed on the screen for (unit: seconds)
-                    *
-                    */
-                displayDurationInSeconds: number;
-                /**
-                    * A url string type to the page in which the notification would direct the user to.
-                    */
-                notificationActionUrlAsString: string;
-        }
-        /**
-            * Displays appNotification after making a validiity check on all of the required parameters, by calling the validateNotificationDisplayParams helper function
-            * An interface object containing all the required parameters to be displayed on the notification would be passed in here
-            * The notificationDisplayParam would be serialized before passing across to the message handler to ensure all objects passed contain simple parameters that would properly pass across the Iframe
-            * @param notificationdisplayparam - Interface object with all the parameters required to display an appNotificiation
-            * @returns a promise resolution upon conclusion
-            * @throws Error if appNotification capability is not supported
-            * @throws Error if notficationDisplayParam was not validated successfully
-            *
-            * @beta
-            */
-        function displayInAppNotification(notificationDisplayParam: NotificationDisplayParam): Promise<void>;
-        /**
-            * Checks if appNotification is supported by the host
-            * @returns boolean to represent whether the appNotification capability is supported
-            * @throws Error if {@linkcode app.initialize} has not successfully completed
-            *
-            * @beta
-            */
-        function isSupported(): boolean;
-}
-
 /**
     * Namespace to interact with the barcode scanning-specific part of the SDK.
     *
@@ -4514,6 +4443,43 @@ export namespace chat {
 }
 export {};
 
+/**
+    * Interact with the system clipboard
+    *
+    * @beta
+    */
+export namespace clipboard {
+        /**
+            * Function to copy data to clipboard.
+            * @remarks
+            * Note: clipboard.write only supports Text, HTML, PNG, and JPEG data format.
+            *       MIME type for Text -> `text/plain`, HTML -> `text/html`, PNG/JPEG -> `image/(png | jpeg)`
+            *       Also, JPEG will be converted to PNG image when copying to clipboard.
+            *
+            * @param blob - A Blob object representing the data to be copied to clipboard.
+            * @returns A string promise which resolves to success message from the clipboard or
+            *          rejects with error stating the reason for failure.
+            */
+        function write(blob: Blob): Promise<void>;
+        /**
+            * Function to read data from clipboard.
+            *
+            * @returns A promise blob which resolves to the data read from the clipboard or
+            *          rejects stating the reason for failure.
+            *          Note: Returned blob type will contain one of the MIME type `image/png`, `text/plain` or `text/html`.
+            */
+        function read(): Promise<Blob>;
+        /**
+            * Checks if clipboard capability is supported by the host
+            * @returns boolean to represent whether the clipboard capability is supported
+            *
+            * @throws Error if {@linkcode app.initialize} has not successfully completed
+            *
+            * @beta
+            */
+        function isSupported(): boolean;
+}
+
 /**
     * This group of capabilities enables apps to show modal dialogs. There are two primary types of dialogs: URL-based dialogs and [Adaptive Card](https://learn.microsoft.com/adaptive-cards/) dialogs.
     * Both types of dialogs are shown on top of your app, preventing interaction with your app while they are displayed.
@@ -4988,7 +4954,7 @@ export namespace pages {
         export 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.
+            * Please note that this method does not yet work on mobile hosts.
             *
             * @param deepLinkParameters - ID and label for the link and fallback URL.
             */