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

package/dist/esm/packages/teams-js/dts/public/dialog.d.ts

@@ -1,286 +0,0 @@
-import { AdaptiveCardDialogInfo, BotAdaptiveCardDialogInfo, BotUrlDialogInfo, DialogInfo, DialogSize, UrlDialogInfo } from './interfaces';
-export declare function updateResizeHelper(apiVersionTag: string, dimensions: DialogSize): void;
-export declare function urlOpenHelper(apiVersionTag: string, urlDialogInfo: UrlDialogInfo, submitHandler?: dialog.DialogSubmitHandler, messageFromChildHandler?: dialog.PostMessageChannel): void;
-export declare function botUrlOpenHelper(apiVersionTag: string, urlDialogInfo: BotUrlDialogInfo, submitHandler?: dialog.DialogSubmitHandler, messageFromChildHandler?: dialog.PostMessageChannel): void;
-export declare function urlSubmitHelper(apiVersionTag: string, result?: string | object, appIds?: string | string[]): void;
-/**
- * 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.
- * - URL-based dialogs allow you to specify a URL from which the contents will be shown inside the dialog.
- *   - For URL dialogs, use the functions and interfaces in the {@link dialog.url} namespace.
- * - Adaptive Card-based dialogs allow you to provide JSON describing an Adaptive Card that will be shown inside the dialog.
- *   - For Adaptive Card dialogs, use the functions and interfaces in the {@link dialog.adaptiveCard} namespace.
- *
- * @remarks Note that dialogs were previously called "task modules". While they have been renamed for clarity, the functionality has been maintained.
- * For more details, see [Dialogs](https://learn.microsoft.com/microsoftteams/platform/task-modules-and-cards/what-are-task-modules)
- *
- * @beta
- */
-export declare namespace dialog {
-    /**
-     * Data Structure to represent the SDK response when dialog closes
-     *
-     * @beta
-     */
-    interface ISdkResponse {
-        /**
-         * Error in case there is a failure before dialog submission
-         */
-        err?: string;
-        /**
-         * Value provided in the `result` parameter by the dialog when the {@linkcode url.submit} function
-         * was called.
-         * If the dialog was closed by the user without submitting (e.g., using a control in the corner
-         * of the dialog), this value will be `undefined` here.
-         */
-        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 url.submit}
-     * or an error if the dialog was closed by the user.
-     *
-     * @see {@linkcode ISdkResponse}
-     *
-     * @beta
-     */
-    type DialogSubmitHandler = (result: ISdkResponse) => void;
-    /**
-     * @hidden
-     * Hide from docs because this function is only used during initialization
-     *
-     * Adds register handlers for messageForChild upon initialization and only in the tasks FrameContext. {@link FrameContexts.task}
-     * Function is called during app initialization
-     * @internal
-     * Limited to Microsoft-internal use
-     *
-     * @beta
-     */
-    function initialize(): void;
-    namespace url {
-        /**
-         * Allows app to open a url based dialog.
-         *
-         * @remarks
-         * This function cannot be called from inside of a dialog
-         *
-         * @param urlDialogInfo - An object containing the parameters of the dialog module.
-         * @param submitHandler - Handler that triggers when a dialog calls the {@linkcode submit} function or when the user closes the dialog.
-         * @param messageFromChildHandler - Handler that triggers if dialog sends a message to the app.
-         *
-         * @beta
-         */
-        function open(urlDialogInfo: UrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): void;
-        /**
-         * Submit the dialog module and close the dialog
-         *
-         * @remarks
-         * This function is only intended to be called from code running within the dialog. Calling it from outside the dialog will have no effect.
-         *
-         * @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;
-        /**
-         * Subcapability that allows communication between the dialog and the parent app.
-         *
-         * @remarks
-         * Note that dialog can be invoked from parentless scenarios e.g. Search Message Extensions. The subcapability `parentCommunication` is not supported in such scenarios.
-         *
-         * @beta
-         */
-        namespace parentCommunication {
-            /**
-             *  Send message to the parent from dialog
-             *
-             * @remarks
-             * This function is only intended to be called from code running within the dialog. Calling it from outside the dialog will have no effect.
-             *
-             * @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;
-            /**
-             * Register a listener that will be triggered when a message is received from the app that opened the dialog.
-             *
-             * @remarks
-             * This function is only intended to be called from code running within the dialog. Calling it from outside the dialog will have no effect.
-             *
-             * @param listener - The listener that will be triggered.
-             *
-             * @beta
-             */
-            function registerOnMessageFromParent(listener: PostMessageChannel): void;
-            /**
-             * Checks if dialog.url.parentCommunication capability is supported by the host
-             *
-             * @returns boolean to represent whether dialog.url.parentCommunication capability is supported
-             *
-             * @throws Error if {@linkcode app.initialize} has not successfully completed
-             *
-             * @beta
-             */
-            function isSupported(): boolean;
-        }
-        /**
-         * Checks if dialog.url module is supported by the host
-         *
-         * @returns boolean to represent whether dialog.url module is supported
-         *
-         * @throws Error if {@linkcode app.initialize} has not successfully completed
-         *
-         * @beta
-         */
-        function isSupported(): boolean;
-        /**
-         * Namespace to open a dialog that sends results to the bot framework
-         *
-         * @beta
-         */
-        namespace bot {
-            /**
-             * Allows an app to open a dialog that sends submitted data to a bot.
-             *
-             * @param botUrlDialogInfo - An object containing the parameters of the dialog module including completionBotId.
-             * @param submitHandler - Handler that triggers when the dialog has been submitted or closed.
-             * @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.url.bot capability is supported by the host
-             *
-             * @returns boolean to represent whether dialog.url.bot is supported
-             *
-             * @throws Error if {@linkcode app.initialize} has not successfully completed
-             *
-             * @beta
-             */
-            function isSupported(): boolean;
-        }
-        /**
-         * @hidden
-         *
-         * Convert UrlDialogInfo to DialogInfo to send the information to host in {@linkcode open} API.
-         *
-         * @internal
-         * Limited to Microsoft-internal use
-         */
-        function getDialogInfoFromUrlDialogInfo(urlDialogInfo: UrlDialogInfo): DialogInfo;
-        /**
-         * @hidden
-         *
-         * Convert BotUrlDialogInfo to DialogInfo to send the information to host in {@linkcode bot.open} API.
-         *
-         * @internal
-         * Limited to Microsoft-internal use
-         */
-        function getDialogInfoFromBotUrlDialogInfo(botUrlDialogInfo: BotUrlDialogInfo): DialogInfo;
-    }
-    /**
-     * This function currently serves no purpose and should not be used. All functionality that used
-     * to be covered by this method is now in subcapabilities and those isSupported methods should be
-     * used directly.
-     *
-     * @hidden
-     */
-    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 capabilty is supported
-         *
-         * @throws Error if {@linkcode app.initialize} has not successfully completed
-         *
-         * @beta
-         */
-        function isSupported(): boolean;
-    }
-    /**
-     * Subcapability for interacting with adaptive card dialogs
-     * @beta
-     */
-    namespace adaptiveCard {
-        /**
-         * Allows app to open an adaptive card based dialog.
-         *
-         * @remarks
-         * This function cannot be called from inside of a dialog
-         *
-         * @param adaptiveCardDialogInfo - An object containing the parameters of the dialog module {@link AdaptiveCardDialogInfo}.
-         * @param submitHandler - Handler that triggers when a dialog calls the {@linkcode url.submit} function or when the user closes the dialog.
-         *
-         * @beta
-         */
-        function open(adaptiveCardDialogInfo: AdaptiveCardDialogInfo, submitHandler?: DialogSubmitHandler): void;
-        /**
-         * Checks if dialog.adaptiveCard module is supported by the host
-         *
-         * @returns boolean to represent whether dialog.adaptiveCard module is supported
-         *
-         * @throws Error if {@linkcode app.initialize} has not successfully completed
-         *
-         * @beta
-         */
-        function isSupported(): boolean;
-        /**
-         * Namespace for interaction with adaptive card dialogs that need to communicate with the bot framework
-         *
-         * @beta
-         */
-        namespace bot {
-            /**
-             * Allows an app to open an adaptive card-based dialog module using bot.
-             *
-             * @param botAdaptiveCardDialogInfo - An object containing the parameters of the dialog module including completionBotId.
-             * @param submitHandler - Handler that triggers when the dialog has been submitted or closed.
-             *
-             * @beta
-             */
-            function open(botAdaptiveCardDialogInfo: BotAdaptiveCardDialogInfo, submitHandler?: DialogSubmitHandler): void;
-            /**
-             * Checks if dialog.adaptiveCard.bot capability is supported by the host
-             *
-             * @returns boolean to represent whether dialog.adaptiveCard.bot is supported
-             *
-             * @throws Error if {@linkcode app.initialize} has not successfully completed
-             *
-             * @beta
-             */
-            function isSupported(): boolean;
-        }
-    }
-}

package/dist/esm/packages/teams-js/dts/public/geoLocation.d.ts

@@ -1,100 +0,0 @@
-/**
- * Namespace to interact with the geoLocation module-specific part of the SDK. This is the newer version of location module.
- *
- * @beta
- */
-export declare namespace geoLocation {
-    /**
-     * Data struture to represent the location information
-     *
-     * @beta
-     */
-    interface Location {
-        /**
-          Latitude of the location
-          */
-        latitude: number;
-        /**
-          Longitude of the location
-          */
-        longitude: number;
-        /**
-          Accuracy describes the maximum distance in meters from the captured coordinates to the possible actual location
-          @remarks
-          This property is only in scope for mobile
-          */
-        accuracy?: number;
-        /**
-          Time stamp when the location was captured
-          */
-        timestamp?: number;
-    }
-    /**
-     * Fetches current user coordinates
-     * @returns Promise that will resolve with {@link geoLocation.Location} object or reject with an error. Function can also throw a NOT_SUPPORTED_ON_PLATFORM error
-     *
-     * @beta
-     */
-    function getCurrentLocation(): Promise<Location>;
-    /**
-     * Checks whether or not location has user permission
-     *
-     * @returns Promise that will resolve with true if the user had granted the app permission to location information, or with false otherwise,
-     * In case of an error, promise will reject with the error. Function can also throw a NOT_SUPPORTED_ON_PLATFORM error
-     *
-     * @beta
-     */
-    function hasPermission(): Promise<boolean>;
-    /**
-     * Requests user permission for location
-     *
-     * @returns true if the user consented permission for location, false otherwise
-     * @returns Promise that will resolve with true if the user consented permission for location, or with false otherwise,
-     * In case of an error, promise will reject with the error. Function can also throw a NOT_SUPPORTED_ON_PLATFORM error
-     *
-     * @beta
-     */
-    function requestPermission(): Promise<boolean>;
-    /**
-     * Checks if geoLocation capability is supported by the host
-     * @returns boolean to represent whether geoLocation is supported
-     *
-     * @throws Error if {@linkcode app.initialize} has not successfully completed
-     *
-     * @beta
-     */
-    function isSupported(): boolean;
-    /**
-     * Namespace to interact with the location on map module-specific part of the SDK.
-     *
-     * @beta
-     */
-    namespace map {
-        /**
-         * Allows user to choose location on map
-         *
-         * @returns Promise that will resolve with {@link geoLocation.Location} object chosen by the user or reject with an error. Function can also throw a NOT_SUPPORTED_ON_PLATFORM error
-         *
-         * @beta
-         */
-        function chooseLocation(): Promise<Location>;
-        /**
-         * Shows the location on map corresponding to the given coordinates
-         *
-         * @param location - Location to be shown on the map
-         * @returns Promise that resolves when the location dialog has been closed or reject with an error. Function can also throw a NOT_SUPPORTED_ON_PLATFORM error
-         *
-         * @beta
-         */
-        function showLocation(location: Location): Promise<void>;
-        /**
-         * Checks if geoLocation.map capability is supported by the host
-         * @returns boolean to represent whether geoLocation.map is supported
-         *
-         * @throws Error if {@linkcode app.initialize} has not successfully completed
-         *
-         * @beta
-         */
-        function isSupported(): boolean;
-    }
-}