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

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

@@ -1,9 +1,10 @@
-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.
+ * Module to interact with the geoLocation module-specific part of the SDK. This is the newer version of location module.
  *
  * @beta
+ * @module
  */
+import * as map from './map';
 /**
  * Data struture to represent the location information
  *

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

@@ -1,3 +1,9 @@
+/**
+ * Module to interact with the location on map module-specific part of the SDK.
+ *
+ * @beta
+ * @module
+ */
 import { Location } from './geoLocation';
 /**
  * Allows user to choose location on map

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

@@ -1,6 +1,6 @@
 export * as authentication from './authentication';
 export { ChannelType, DialogDimension, FrameContexts, HostClientType, HostName, TaskModuleDimension, TeamType, UserTeamRole, } from './constants';
-export { ActionInfo, ActionObjectType, AdaptiveCardVersion, AdaptiveCardDialogInfo, BaseActionObject, BotAdaptiveCardDialogInfo, BotUrlDialogInfo, Context, DeepLinkParameters, DialogInfo, DialogSize, ErrorCode, FileOpenPreference, FrameContext, FrameInfo, LoadContext, LocaleInfo, M365ContentAction, ResumeContext, SdkError, SecondaryId, SecondaryM365ContentIdName, ShareDeepLinkParameters, TabInformation, TabInstance, TabInstanceParameters, TaskInfo, TeamInformation, UrlDialogInfo, } from './interfaces';
+export { ActionInfo, ActionObjectType, AdaptiveCardVersion, AdaptiveCardDialogInfo, BaseActionObject, BotAdaptiveCardDialogInfo, BotUrlDialogInfo, Context, DeepLinkParameters, DialogInfo, DialogSize, ErrorCode, FileOpenPreference, FrameContext, FrameInfo, HostToAppPerformanceMetrics, LoadContext, LocaleInfo, M365ContentAction, ResumeContext, SdkError, SecondaryId, SecondaryM365ContentIdName, ShareDeepLinkParameters, TabInformation, TabInstance, TabInstanceParameters, TaskInfo, TeamInformation, UrlDialogInfo, } from './interfaces';
 export * as app from './app/app';
 export { AppId } from './appId';
 export { EmailAddress } from './emailAddress';
@@ -13,26 +13,26 @@ export * as dialog from './dialog/dialog';
 export * as nestedAppAuth from './nestedAppAuth';
 export * as geoLocation from './geoLocation/geoLocation';
 export { getAdaptiveCardSchemaVersion } from './adaptiveCards';
-export { pages } from './pages';
+export * as pages from './pages/pages';
 export { addEventListnerFunctionType, ChildAppWindow, IAppWindow, onCompleteFunctionType, ParentAppWindow, } from './appWindow';
 export * as menus from './menus';
 export * as media from './media';
 export * as secondaryBrowser from './secondaryBrowser';
 export * as location from './location';
-export { meeting } from './meeting';
+export * as meeting from './meeting/meeting';
 export * as monetization from './monetization';
 export * as calendar from './calendar';
 export * as mail from './mail';
 export * as teamsCore from './teamsAPIs';
 export * as people from './people';
-export { profile } from './profile';
-export { videoEffects } from './videoEffects';
+export * as profile from './profile';
+export * as videoEffects from './videoEffects';
 export * as search from './search';
-export { sharing } from './sharing';
-export { stageView } from './stageView';
+export * as sharing from './sharing/sharing';
+export * as stageView from './stageView/stageView';
 export { version } from './version';
-export { visualMedia } from './visualMedia';
-export { webStorage } from './webStorage';
+export * as visualMedia from './visualMedia/visualMedia';
+export * as webStorage from './webStorage';
 export * as call from './call';
 export * as appInitialization from './appInitialization';
 export * as thirdPartyCloudStorage from './thirdPartyCloudStorage';

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

@@ -1142,3 +1142,14 @@ export interface ClipboardParams {
     /** Blob content in Base64 string format */
     content: string;
 }
+/**
+ * Meant for passing data to the app related to host-to-app message performance metrics.
+ */
+export interface HostToAppPerformanceMetrics {
+    /** The name of the action the host is responding to. */
+    actionName: string;
+    /** The delay the message took traveling from host to app */
+    messageDelay: number;
+    /** The time when the request was dispatched */
+    requestStartedAt: number;
+}

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

@@ -3,6 +3,7 @@
  * For more information, visit https://aka.ms/teamsliveshare
  *
  * @see LiveShareHost
+ * @module
  */
 /**
  * @hidden

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

@@ -1,10 +1,11 @@
-import { SdkError } from './interfaces';
 /**
  * @deprecated
- * As of 2.1.0, please use geoLocation namespace.
+ * As of 2.1.0, please use geoLocation module.
  *
  * Module to interact with the location module-specific part of the SDK.
+ * @module
  */
+import { SdkError } from './interfaces';
 /** Get location callback function type */
 export type getLocationCallbackFunctionType = (error: SdkError, location: Location) => void;
 /** Show location callback function type */
@@ -73,7 +74,7 @@ export declare function getLocation(props: LocationProps, callback: getLocationC
 export declare function showLocation(location: Location, callback: showLocationCallbackFunctionType): void;
 /**
  * @deprecated
- * As of 2.1.0, please use geoLocation namespace, and use {@link geoLocation.isSupported geoLocation.isSupported: boolean} to check if geoLocation is supported.
+ * As of 2.1.0, please use geoLocation module, and use {@link geoLocation.isSupported geoLocation.isSupported: boolean} to check if geoLocation is supported.
  *
  * Checks if Location capability is supported by the host
  *

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

@@ -1,5 +1,6 @@
 /**
  * Used to interact with mail capability, including opening and composing mail.
+ * @module
  */
 /**
  * Opens a mail message in the host.

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

@@ -2,6 +2,7 @@
  * @hidden
  * Module for an app to support a checkout flow by interacting with the marketplace cart in the host.
  * @beta
+ * @module
  */
 /**
  * @hidden

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

@@ -1,7 +1,4 @@
 import { SdkError } from './interfaces';
-/**
- * Interact with media, including capturing and viewing images.
- */
 /**
  * Function callback type used when calling {@link media.captureImage}.
  *

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

@@ -0,0 +1,51 @@
+/**
+ * Module for functions to control behavior of the app share button
+ *
+ * @hidden
+ * Hide from docs.
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ *
+ * @beta
+ * @module
+ */
+/**
+ * Property bag for the setVisibilityInfo
+ *
+ * @hidden
+ * Hide from docs.
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ *
+ * @beta
+ */
+export interface ShareInformation {
+    /**
+     * boolean flag to set show or hide app share button
+     */
+    isVisible: boolean;
+    /**
+     * optional string contentUrl, which will override contentUrl coming from Manifest
+     */
+    contentUrl?: string;
+}
+/**
+ * By default app share button will be hidden and this API will govern the visibility of it.
+ *
+ * This function can be used to hide/show app share button in meeting,
+ * along with contentUrl (overrides contentUrl populated in app manifest)
+ * @throws standard Invalid Url error
+ * @param shareInformation has two elements, one isVisible boolean flag and another
+ * optional string contentUrl, which will override contentUrl coming from Manifest
+ *
+ * @hidden
+ * Hide from docs.
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ *
+ * @beta
+ */
+export declare function setOptions(shareInformation: ShareInformation): void;