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

package/dist/MicrosoftTeams.d.ts

@@ -61,7 +61,7 @@ export interface ThreadMember {
     * @internal
     * Limited to Microsoft-internal use
     */
-export const enum NotificationTypes {
+export enum NotificationTypes {
         fileDownloadStart = "fileDownloadStart",
         fileDownloadComplete = "fileDownloadComplete"
 }
@@ -81,7 +81,7 @@ export interface ShowNotificationParameters {
     * @internal
     * Limited to Microsoft-internal use
     */
-export const enum ViewerActionTypes {
+export enum ViewerActionTypes {
         view = "view",
         edit = "edit",
         editNew = "editNew"
@@ -91,7 +91,7 @@ export const enum ViewerActionTypes {
     *
     * User setting changes that can be subscribed to
     */
-export const enum UserSettingTypes {
+export enum UserSettingTypes {
         /**
             * @hidden
             * Use this key to subscribe to changes in user's file open preference
@@ -610,7 +610,7 @@ export namespace externalAppAuthentication {
             * @internal
             * Limited to Microsoft-internal use
             */
-        const enum OriginalRequestType {
+        enum OriginalRequestType {
                 ActionExecuteInvokeRequest = "ActionExecuteInvokeRequest",
                 QueryMessageExtensionRequest = "QueryMessageExtensionRequest"
         }
@@ -627,7 +627,7 @@ export namespace externalAppAuthentication {
             * @internal
             * Limited to Microsoft-internal use
             */
-        const enum InvokeResponseType {
+        enum InvokeResponseType {
                 ActionExecuteInvokeResponse = "ActionExecuteInvokeResponse",
                 QueryMessageExtensionResponse = "QueryMessageExtensionResponse"
         }
@@ -733,7 +733,7 @@ export namespace externalAppAuthentication {
             * @internal
             * Limited to Microsoft-internal use
             */
-        const enum InvokeErrorCode {
+        enum InvokeErrorCode {
                 INTERNAL_ERROR = "INTERNAL_ERROR"
         }
         /**
@@ -783,6 +783,18 @@ export namespace externalAppAuthentication {
             * @returns A promise that resolves when authentication succeeds and rejects with InvokeError on failure
             */
         function authenticateWithOauth2(titleId: string, oauthConfigId: string, oauthWindowParameters: OauthWindowProperties): Promise<void>;
+        /**
+            * @beta
+            * @hidden
+            * API to authenticate power platform connector plugins
+            * @internal
+            * Limited to Microsoft-internal use
+            * @param titleId ID of the acquisition
+            * @param signInUrl signInUrl for the connctor page listing the connector. This is optional
+            * @param oauthWindowParameters parameters for the signIn window
+            * @returns A promise that resolves when authentication succeeds and rejects with InvokeError on failure
+            */
+        function authenticateWithPowerPlatformConnectorPlugins(titleId: string, signInUrl?: URL, oauthWindowParameters?: OauthWindowProperties): Promise<void>;
         /**
             * @hidden
             * Checks if the externalAppAuthentication capability is supported by the host
@@ -809,7 +821,7 @@ export namespace externalAppCardActions {
             * @internal
             * Limited to Microsoft-internal use
             */
-        const enum ActionOpenUrlType {
+        enum ActionOpenUrlType {
                 DeepLinkDialog = "DeepLinkDialog",
                 DeepLinkOther = "DeepLinkOther",
                 DeepLinkStageView = "DeepLinkStageView",
@@ -832,7 +844,7 @@ export namespace externalAppCardActions {
             * @internal
             * Limited to Microsoft-internal use
             */
-        const enum ActionOpenUrlErrorCode {
+        enum ActionOpenUrlErrorCode {
                 INTERNAL_ERROR = "INTERNAL_ERROR",
                 INVALID_LINK = "INVALID_LINK",
                 NOT_SUPPORTED = "NOT_SUPPORTED"
@@ -1031,7 +1043,7 @@ export namespace files {
             * @internal
             * Limited to Microsoft-internal use
             */
-        export const enum CloudStorageProvider {
+        export enum CloudStorageProvider {
                 Dropbox = "DROPBOX",
                 Box = "BOX",
                 Sharefile = "SHAREFILE",
@@ -1068,7 +1080,7 @@ export namespace files {
             * @internal
             * Limited to Microsoft-internal use
             */
-        export const enum CloudStorageProviderType {
+        export enum CloudStorageProviderType {
                 Sharepoint = 0,
                 WopiIntegration = 1,
                 Google = 2,
@@ -1286,7 +1298,7 @@ export namespace files {
             * @internal
             * Limited to Microsoft-internal use
             */
-        export const enum SpecialDocumentLibraryType {
+        export enum SpecialDocumentLibraryType {
                 ClassMaterials = "classMaterials"
         }
         /**
@@ -1297,7 +1309,7 @@ export namespace files {
             * @internal
             * Limited to Microsoft-internal use
             */
-        export const enum DocumentLibraryAccessType {
+        export enum DocumentLibraryAccessType {
                 Readonly = "readonly"
         }
         /**
@@ -1339,7 +1351,7 @@ export namespace files {
             * @internal
             * Limited to Microsoft-internal use
             */
-        export const enum FileDownloadStatus {
+        export enum FileDownloadStatus {
                 Downloaded = "Downloaded",
                 Downloading = "Downloading",
                 Failed = "Failed"
@@ -1441,7 +1453,7 @@ export namespace files {
             * @internal
             * Limited to Microsoft-internal use
             */
-        export const enum CloudStorageProviderFileAction {
+        export enum CloudStorageProviderFileAction {
                 Download = "DOWNLOAD",
                 Upload = "UPLOAD",
                 Delete = "DELETE"
@@ -1994,21 +2006,88 @@ export namespace meetingRoom {
     * Limited to Microsoft-internal use
     */
 export namespace messageChannels {
-        /**
-            * @hidden
-            * @beta
-            *
-            * Fetches a MessagePort to batch telemetry through the host's telemetry worker.
-            * The port is cached once received, so subsequent calls return the same port.
-            * @returns MessagePort.
-            *
-            * @throws Error if {@linkcode app.initialize} has not successfully completed,
-            * if the host does not support the feature, or if the port request is rejected.
-            *
-            * @internal
-            * Limited to Microsoft-internal use
-            */
-        function getTelemetryPort(): Promise<MessagePort>;
+        namespace telemetry {
+                /**
+                    * @hidden
+                    * @beta
+                    *
+                    * Fetches a MessagePort to batch telemetry through the host's telemetry worker.
+                    * The port is cached once received, so subsequent calls return the same port.
+                    * @returns MessagePort.
+                    *
+                    * @throws Error if {@linkcode app.initialize} has not successfully completed,
+                    * if the host does not support the feature, or if the port request is rejected.
+                    *
+                    * @internal
+                    * Limited to Microsoft-internal use
+                    */
+                function getTelemetryPort(): Promise<MessagePort>;
+                /**
+                    * @hidden
+                    *
+                    * @beta
+                    *
+                    * Checks if the messageChannels.telemetry capability is supported by the host
+                    * @returns boolean to represent whether the messageChannels.telemetry capability is supported
+                    *
+                    * @throws Error if {@linkcode app.initialize} has not successfully completed
+                    *
+                    * @internal
+                    * Limited to Microsoft-internal use
+                    */
+                function isSupported(): boolean;
+                /**
+                    * @hidden
+                    * Undocumented function used to clear state between unit tests
+                    *
+                    * @beta
+                    *
+                    * @internal
+                    * Limited to Microsoft-internal use
+                    */
+                function _clearTelemetryPort(): void;
+        }
+        namespace dataLayer {
+                /**
+                    * @hidden
+                    * @beta
+                    *
+                    * Fetches a MessagePort to allow access to the host's data layer worker.
+                    * The port is cached once received, so subsequent calls return the same port.
+                    * @returns MessagePort.
+                    *
+                    * @throws Error if {@linkcode app.initialize} has not successfully completed,
+                    * if the host does not support the feature, or if the port request is rejected.
+                    *
+                    * @internal
+                    * Limited to Microsoft-internal use
+                    */
+                function getDataLayerPort(): Promise<MessagePort>;
+                /**
+                    * @hidden
+                    *
+                    * @beta
+                    *
+                    * Checks if the messageChannels.dataLayer capability is supported by the host
+                    * @returns boolean to represent whether the messageChannels.dataLayer capability is supported
+                    *
+                    * @throws Error if {@linkcode app.initialize} has not successfully completed
+                    *
+                    * @internal
+                    * Limited to Microsoft-internal use
+                    */
+                function isSupported(): boolean;
+                /**
+                    * @hidden
+                    * Undocumented function used to clear state between unit tests
+                    *
+                    * @beta
+                    *
+                    * @internal
+                    * Limited to Microsoft-internal use
+                    */
+                function _clearDataLayerPort(): void;
+        }
         /**
             * @hidden
             *
@@ -2023,16 +2102,6 @@ export namespace messageChannels {
             * Limited to Microsoft-internal use
             */
         function isSupported(): boolean;
-        /**
-            * @hidden
-            * Undocumented function used to clear state between unit tests
-            *
-            * @beta
-            *
-            * @internal
-            * Limited to Microsoft-internal use
-            */
-        function _clearTelemetryPort(): void;
 }
 
 export namespace notifications {
@@ -2280,7 +2349,7 @@ export namespace remoteCamera {
             * @internal
             * Limited to Microsoft-internal use
             */
-        const enum ErrorReason {
+        enum ErrorReason {
                 CommandResetError = 0,
                 CommandZoomInError = 1,
                 CommandZoomOutError = 2,
@@ -2322,7 +2391,7 @@ export namespace remoteCamera {
             * @internal
             * Limited to Microsoft-internal use
             */
-        const enum SessionTerminatedReason {
+        enum SessionTerminatedReason {
                 None = 0,
                 ControlDenied = 1,
                 ControlNoResponse = 2,
@@ -2531,7 +2600,7 @@ export namespace appEntity {
 }
 
 export namespace teams {
-        const enum ChannelType {
+        enum ChannelType {
                 Regular = 0,
                 Private = 1,
                 Shared = 2
@@ -2655,7 +2724,7 @@ export namespace videoEffectsEx {
             * @internal
             * Limited to Microsoft-internal use
             */
-        const enum ErrorLevel {
+        enum ErrorLevel {
                 Fatal = "fatal",
                 Warn = "warn"
         }
@@ -6007,14 +6076,10 @@ export namespace pages {
         }
         /**
             * Provides functions for navigating without needing to specify your application ID.
-            *
-            * @beta
             */
         namespace currentApp {
                 /**
                     * Parameters for the NavigateWithinApp
-                    *
-                    * @beta
                     */
                 interface NavigateWithinAppParams {
                         /**
@@ -6033,14 +6098,11 @@ export namespace pages {
                     * specific content within the page).
                     * @param params - Parameters for the navigation
                     * @returns a promise that will resolve if the navigation was successful
-                    *
-                    * @beta
                     */
                 function navigateTo(params: NavigateWithinAppParams): Promise<void>;
                 /**
                     * Navigate to the currently running application's first static page defined in the application
                     * manifest.
-                    * @beta
                     */
                 function navigateToDefaultPage(): Promise<void>;
                 /**
@@ -6048,8 +6110,6 @@ export namespace pages {
                     * @returns boolean to represent whether the pages.currentApp capability is supported
                     *
                     * @throws Error if {@linkcode app.initialize} has not successfully completed
-                    *
-                    * @beta
                     */
                 function isSupported(): boolean;
         }
@@ -6937,7 +6997,23 @@ export namespace meeting {
             * Hide from docs
             * Data structure to represent call details
             */
-        type ICallDetails = IMeetingOrCallDetailsBase<CallType>;
+        interface ICallDetails extends IMeetingOrCallDetailsBase<CallType> {
+                /**
+                    * @hidden
+                    * Phone number of a PSTN caller or email of a VoIP caller
+                    */
+                originalCaller?: string;
+                /**
+                    * @hidden
+                    * Phone number of a PSTN callee or email of a VoIP callee
+                    */
+                dialedEntity?: never;
+                /**
+                    * @hidden
+                    * Tracking identifier for grouping related calls
+                    */
+                trackingId?: never;
+        }
         /**
             * @hidden
             * Hide from docs
@@ -6949,6 +7025,11 @@ export namespace meeting {
                     * Scheduled end time of the meeting
                     */
                 scheduledEndTime: string;
+                /**
+                    * @hidden
+                    * event id of the meeting
+                    */
+                id?: string;
                 /**
                     * @hidden
                     * meeting title name of the meeting
@@ -7348,6 +7429,10 @@ export namespace meeting {
             */
         function toggleIncomingClientAudio(callback: errorCallbackFunctionType): void;
         /**
+            * @throws error if your app manifest does not include the `OnlineMeeting.ReadBasic.Chat` RSC permission.
+            * Find the app manifest reference at https://learn.microsoft.com/en-us/microsoftteams/platform/resources/schema/manifest-schema.
+            * Find the RSC reference at https://learn.microsoft.com/en-us/microsoftteams/platform/graph-api/rsc/resource-specific-consent.
+            *
             * @hidden
             * Allows an app to get the meeting details for the meeting
             *
@@ -7359,6 +7444,24 @@ export namespace meeting {
             * Limited to Microsoft-internal use
             */
         function getMeetingDetails(callback: (error: SdkError | null, meetingDetails: IMeetingDetailsResponse | null) => void): void;
+        /**
+            * @throws error if your app manifest does not include both the `OnlineMeeting.ReadBasic.Chat` RSC permission
+            * and the `OnlineMeetingParticipant.Read.Chat` RSC permission.
+            * Find the app manifest reference at https://learn.microsoft.com/en-us/microsoftteams/platform/resources/schema/manifest-schema.
+            * Find the RSC reference at https://learn.microsoft.com/en-us/microsoftteams/platform/graph-api/rsc/resource-specific-consent.
+            *
+            * @throws `not supported on platform` error if your app is run on a host that does not support returning additional meeting details.
+            *
+            * @hidden
+            * Allows an app to get the additional meeting details for the meeting.
+            * Some additional details are returned on a best-effort basis. They may not be present for every meeting.
+            *
+            * @internal
+            * Limited to Microsoft-internal use
+            *
+            * @beta
+            */
+        function getMeetingDetailsVerbose(): Promise<IMeetingDetailsResponse>;
         /**
             * @hidden
             * Allows an app to get the authentication token for the anonymous or guest user in the meeting
@@ -10095,7 +10198,7 @@ export namespace marketplace {
   * @internal
   * Limited to Microsoft-internal use
   */
-export const enum ExternalAppErrorCode {
+export enum ExternalAppErrorCode {
     INTERNAL_ERROR = "INTERNAL_ERROR"
 }