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

package/dist/esm/packages/teams-js/dts/internal/appHelpers.d.ts

@@ -1,4 +1,4 @@
-import * as app from '../public/app';
+import * as app from '../public/app/app';
 export declare function appInitializeHelper(apiVersionTag: string, validMessageOrigins?: string[]): Promise<void>;
 export declare function notifyAppLoadedHelper(apiVersionTag: string): void;
 export declare function notifyExpectedFailureHelper(apiVersionTag: string, expectedFailureRequest: app.IExpectedFailureRequest): void;

package/dist/esm/packages/teams-js/dts/internal/dialogHelpers.d.ts

@@ -0,0 +1,32 @@
+import * as dialog from '../public/dialog/dialog';
+import { AdaptiveCardDialogInfo, BotAdaptiveCardDialogInfo } from '../public/interfaces';
+import { BotUrlDialogInfo, DialogInfo, DialogSize, UrlDialogInfo } from '../public/interfaces';
+import { ApiVersionNumber } from './telemetry';
+/**
+ * v2 APIs telemetry file: All of APIs in this capability file should send out API version v2 ONLY
+ */
+export declare const dialogTelemetryVersionNumber: ApiVersionNumber;
+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;
+/**
+ * @hidden
+ * Hide from docs
+ * --------
+ * Convert AdaptiveCardDialogInfo to DialogInfo to send the information to host in {@linkcode adaptiveCard.open} API.
+ *
+ * @internal
+ */
+export declare function getDialogInfoFromAdaptiveCardDialogInfo(adaptiveCardDialogInfo: AdaptiveCardDialogInfo): DialogInfo;
+/**
+ * @hidden
+ * Hide from docs
+ * --------
+ * Convert BotAdaptiveCardDialogInfo to DialogInfo to send the information to host in {@linkcode adaptiveCard.open} API.
+ *
+ * @internal
+ */
+export declare function getDialogInfoFromBotAdaptiveCardDialogInfo(botAdaptiveCardDialogInfo: BotAdaptiveCardDialogInfo): DialogInfo;
+export declare const storedMessages: string[];
+export declare function handleDialogMessage(message: string): void;

package/dist/esm/packages/teams-js/dts/internal/marketplaceUtils.d.ts

@@ -1,4 +1,4 @@
-import { marketplace } from '../public/marketplace';
+import * as marketplace from '../public/marketplace';
 /**
  * @hidden
  * deserialize the cart data:

package/dist/esm/packages/teams-js/dts/internal/mediaUtil.d.ts

@@ -1,5 +1,5 @@
-import { media } from '../public/media';
-import { people } from '../public/people';
+import * as media from '../public/media';
+import * as people from '../public/people';
 /**
  * @hidden
  * Helper function to create a blob from media chunks based on their sequence

package/dist/esm/packages/teams-js/dts/public/{app.d.ts → app/app.d.ts}

@@ -1,5 +1,6 @@
-import { ChannelType, FrameContexts, HostClientType, HostName, TeamType, UserTeamRole } from './constants';
-import { ActionInfo, FileOpenPreference, LocaleInfo, ResumeContext } from './interfaces';
+import { ChannelType, FrameContexts, HostClientType, HostName, TeamType, UserTeamRole } from '../constants';
+import { ActionInfo, FileOpenPreference, LocaleInfo } from '../interfaces';
+import * as lifecycle from './lifecycle';
 /** App Initialization Messages */
 export declare const Messages: {
     /** App loaded. */
@@ -112,9 +113,17 @@ export interface AppInfo {
      */
     iconPositionVertical?: number;
     /**
-     * Time when the user clicked on the tab
+     * Time when the user clicked on the tab using the date.
+     *
+     * For measuring elapsed time between the moment the user click the tab, use {@link app.AppInfo.userClickTimeV2 | app.Context.app.userClickTimeV2} instead as it uses the performance timer API.
      */
     userClickTime?: number;
+    /**
+     * Time when the user click on the app by using the performance timer API. Useful for measuring elapsed time accurately.
+     *
+     * For displaying the time when the user clicked on the app, please use {@link app.AppInfo.userClickTime | app.Context.app.userClickTime} as it uses the date.
+     */
+    userClickTimeV2?: number;
     /**
      * The ID of the parent message from which this task module was launched.
      * This is only available in task modules launched from bot cards.
@@ -549,44 +558,4 @@ export declare function registerOnThemeChangeHandler(handler: themeHandler): voi
  * does not necessarily indicate whether the target loaded successfully.
  */
 export declare function openLink(deepLink: string): Promise<void>;
-/**
- * A namespace for enabling the suspension or delayed termination of an app when the user navigates away.
- * When an app registers for the registerBeforeSuspendOrTerminateHandler, it chooses to delay termination.
- * When an app registers for both registerBeforeSuspendOrTerminateHandler and registerOnResumeHandler, it chooses the suspension of the app .
- * Please note that selecting suspension doesn't guarantee prevention of background termination.
- * The outcome is influenced by factors such as available memory and the number of suspended apps.
- *
- * @beta
- */
-export declare namespace lifecycle {
-    /**
-     * Register on resume handler function type
-     *
-     * @param context - Data structure to be used to pass the context to the app.
-     */
-    type registerOnResumeHandlerFunctionType = (context: ResumeContext) => void;
-    /**
-     * Register before suspendOrTerminate handler function type
-     *
-     * @returns void
-     */
-    type registerBeforeSuspendOrTerminateHandlerFunctionType = () => Promise<void>;
-    /**
-     * Registers a handler to be called before the page is suspended or terminated. Once a user navigates away from an app,
-     * the handler will be invoked. App developers can use this handler to save unsaved data, pause sync calls etc.
-     *
-     * @param handler - The handler to invoke before the page is suspended or terminated. When invoked, app can perform tasks like cleanups, logging etc.
-     * Upon returning, the app will be suspended or terminated.
-     *
-     */
-    function registerBeforeSuspendOrTerminateHandler(handler: registerBeforeSuspendOrTerminateHandlerFunctionType): void;
-    /**
-     * Registers a handler to be called when the page has been requested to resume from being suspended.
-     *
-     * @param handler - The handler to invoke when the page is requested to be resumed. The app is supposed to navigate to
-     * the appropriate page using the ResumeContext. Once done, the app should then call {@link notifySuccess}.
-     *
-     * @beta
-     */
-    function registerOnResumeHandler(handler: registerOnResumeHandlerFunctionType): void;
-}
+export { lifecycle };

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

@@ -0,0 +1,40 @@
+import { ResumeContext } from '../interfaces';
+/**
+ * A namespace for enabling the suspension or delayed termination of an app when the user navigates away.
+ * When an app registers for the registerBeforeSuspendOrTerminateHandler, it chooses to delay termination.
+ * When an app registers for both registerBeforeSuspendOrTerminateHandler and registerOnResumeHandler, it chooses the suspension of the app .
+ * Please note that selecting suspension doesn't guarantee prevention of background termination.
+ * The outcome is influenced by factors such as available memory and the number of suspended apps.
+ *
+ * @beta
+ */
+/**
+ * Register on resume handler function type
+ *
+ * @param context - Data structure to be used to pass the context to the app.
+ */
+export type registerOnResumeHandlerFunctionType = (context: ResumeContext) => void;
+/**
+ * Register before suspendOrTerminate handler function type
+ *
+ * @returns void
+ */
+export type registerBeforeSuspendOrTerminateHandlerFunctionType = () => Promise<void>;
+/**
+ * Registers a handler to be called before the page is suspended or terminated. Once a user navigates away from an app,
+ * the handler will be invoked. App developers can use this handler to save unsaved data, pause sync calls etc.
+ *
+ * @param handler - The handler to invoke before the page is suspended or terminated. When invoked, app can perform tasks like cleanups, logging etc.
+ * Upon returning, the app will be suspended or terminated.
+ *
+ */
+export declare function registerBeforeSuspendOrTerminateHandler(handler: registerBeforeSuspendOrTerminateHandlerFunctionType): void;
+/**
+ * Registers a handler to be called when the page has been requested to resume from being suspended.
+ *
+ * @param handler - The handler to invoke when the page is requested to be resumed. The app is supposed to navigate to
+ * the appropriate page using the ResumeContext. Once done, the app should then call {@link notifySuccess}.
+ *
+ * @beta
+ */
+export declare function registerOnResumeHandler(handler: registerOnResumeHandlerFunctionType): void;

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

@@ -1,4 +1,4 @@
-import { ExpectedFailureReason, FailedReason, IExpectedFailureRequest, IFailedRequest, Messages } from './app';
+import { ExpectedFailureReason, FailedReason, IExpectedFailureRequest, IFailedRequest, Messages } from './app/app';
 /**
  * @deprecated
  * As of TeamsJS v2.0.0, please use {@link app.Messages} instead.

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

@@ -35,32 +35,30 @@ export interface OpenGroupChatRequest extends OpenChatRequest {
 /**
  * Contains functionality to start chat with others
  */
-export declare namespace chat {
-    /**
-     * Allows the user to open a chat with a single user and allows
-     * for the user to specify the message they wish to send.
-     *
-     * @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
-     */
-    function openChat(openChatRequest: OpenSingleChatRequest): Promise<void>;
-    /**
-     * Allows the user to create a chat with multiple users (2+) and allows
-     * for the user to specify a message and name the topic of the conversation. If
-     * only 1 user is provided into users array default back to origin openChat.
-     *
-     * @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
-     */
-    function openGroupChat(openChatRequest: OpenGroupChatRequest): Promise<void>;
-    /**
-     * Checks if the chat capability is supported by the host
-     * @returns boolean to represent whether the chat capability is supported
-     *
-     * @throws Error if {@linkcode app.initialize} has not successfully completed
-     */
-    function isSupported(): boolean;
-}
+/**
+ * Allows the user to open a chat with a single user and allows
+ * for the user to specify the message they wish to send.
+ *
+ * @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
+ */
+export declare function openChat(openChatRequest: OpenSingleChatRequest): Promise<void>;
+/**
+ * Allows the user to create a chat with multiple users (2+) and allows
+ * for the user to specify a message and name the topic of the conversation. If
+ * only 1 user is provided into users array default back to origin openChat.
+ *
+ * @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
+ */
+export declare function openGroupChat(openChatRequest: OpenGroupChatRequest): Promise<void>;
+/**
+ * Checks if the chat capability is supported by the host
+ * @returns boolean to represent whether the chat capability is supported
+ *
+ * @throws Error if {@linkcode app.initialize} has not successfully completed
+ */
+export declare function isSupported(): boolean;
 export {};

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

@@ -0,0 +1,30 @@
+import { AdaptiveCardDialogInfo } from '../../interfaces';
+import { DialogSubmitHandler } from '../dialog';
+import * as bot from './bot';
+/**
+ * Subcapability for interacting with adaptive card dialogs
+ * @beta
+ */
+/**
+ * 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 fires an [Action.Submit](https://adaptivecards.io/explorer/Action.Submit.html) or when the user closes the dialog.
+ *
+ * @beta
+ */
+export declare 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
+ */
+export declare function isSupported(): boolean;
+export { bot };

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

@@ -0,0 +1,26 @@
+import { BotAdaptiveCardDialogInfo } from '../../interfaces';
+import { DialogSubmitHandler } from '../dialog';
+/**
+ * Module for interaction with adaptive card dialogs that need to communicate with the bot framework
+ *
+ * @beta
+ */
+/**
+ * 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
+ */
+export declare 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
+ */
+export declare function isSupported(): boolean;

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

@@ -0,0 +1,69 @@
+import * as adaptiveCard from './adaptiveCard/adaptiveCard';
+import * as update from './update';
+import * as url from './url/url';
+/**
+ * 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 url} module.
+ * - 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 adaptiveCard} module.
+ *
+ * @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
+ */
+/**
+ * Data Structure to represent the SDK response when dialog closes
+ *
+ * @beta
+ */
+export 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
+ */
+export 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
+ */
+export 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
+ */
+export declare function initialize(): void;
+/**
+ * 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
+ */
+export declare function isSupported(): boolean;
+export { adaptiveCard, url, update };

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

@@ -0,0 +1,23 @@
+import { DialogSize } from '../interfaces';
+/**
+ * Module to update the dialog
+ *
+ * @beta
+ */
+/**
+ * Update dimensions - height/width of a dialog.
+ *
+ * @param dimensions - An object containing width and height properties.
+ *
+ * @beta
+ */
+export declare 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
+ */
+export declare function isSupported(): boolean;

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

@@ -0,0 +1,29 @@
+import { BotUrlDialogInfo } from '../../interfaces';
+import { DialogSubmitHandler, PostMessageChannel } from '../dialog';
+/**
+ * Module to open a dialog that sends results to the bot framework
+ *
+ * @beta
+ */
+/**
+ * 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
+ */
+export declare 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
+ */
+export declare function isSupported(): boolean;

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

@@ -0,0 +1,49 @@
+import { PostMessageChannel } from '../dialog';
+/**
+ * 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
+ */
+/**
+ *  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
+ */
+export declare function sendMessageToParentFromDialog(message: any): void;
+/**
+ *  Send message to the dialog from the parent
+ *
+ * @param message - The message to send
+ *
+ * @beta
+ */
+export declare 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
+ */
+export declare 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
+ */
+export declare function isSupported(): boolean;

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

@@ -0,0 +1,60 @@
+import { BotUrlDialogInfo, DialogInfo, UrlDialogInfo } from '../../interfaces';
+import { DialogSubmitHandler, PostMessageChannel } from '../dialog';
+import * as bot from './bot';
+import * as parentCommunication from './parentCommunication';
+/**
+ * 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
+ */
+export declare 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
+ */
+export declare function submit(result?: string | object, appIds?: string | string[]): void;
+/**
+ * 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
+ */
+export declare function isSupported(): boolean;
+/**
+ * @hidden
+ *
+ * Convert UrlDialogInfo to DialogInfo to send the information to host in {@linkcode open} API.
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare 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
+ */
+export declare function getDialogInfoFromBotUrlDialogInfo(botUrlDialogInfo: BotUrlDialogInfo): DialogInfo;
+export { bot, parentCommunication };

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

@@ -0,0 +1,67 @@
+import * as map from './map';
+/**
+ * Namespace to interact with the geoLocation module-specific part of the SDK. This is the newer version of location module.
+ *
+ * @beta
+ */
+/**
+ * Data struture to represent the location information
+ *
+ * @beta
+ */
+export 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
+ */
+export declare 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
+ */
+export declare 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
+ */
+export declare 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
+ */
+export declare function isSupported(): boolean;
+export { map };

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

@@ -0,0 +1,27 @@
+import { Location } from './geoLocation';
+/**
+ * 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
+ */
+export declare 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
+ */
+export declare 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
+ */
+export declare function isSupported(): boolean;