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

package/dist/esm/packages/teams-js/dts/private/messageChannels/messageChannels.d.ts

@@ -0,0 +1,28 @@
+/**
+ * @hidden
+ * Module to request message ports from the host application.
+ *
+ * @beta
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ *
+ * @module
+ */
+import * as dataLayer from './dataLayer';
+import * as telemetry from './telemetry';
+/**
+ * @hidden
+ *
+ * @beta
+ *
+ * Checks if the messageChannels capability is supported by the host
+ * @returns boolean to represent whether the messageChannels capability is supported
+ *
+ * @throws Error if {@linkcode app.initialize} has not successfully completed
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare function isSupported(): boolean;
+export { dataLayer, telemetry };

package/dist/esm/packages/teams-js/dts/private/messageChannels/telemetry.d.ts

@@ -0,0 +1,39 @@
+/**
+ * @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
+ */
+export declare 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
+ */
+export declare function isSupported(): boolean;
+/**
+ * @hidden
+ * Undocumented function used to clear state between unit tests
+ *
+ * @beta
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare function _clearTelemetryPort(): void;

package/dist/esm/packages/teams-js/dts/private/notifications.d.ts

@@ -1,26 +1,32 @@
+/**
+ * @hidden
+ * Hidden from Docs
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ * @module
+ */
 import { ShowNotificationParameters } from './interfaces';
-export declare namespace notifications {
-    /**
-     * @hidden
-     * display notification API.
-     *
-     * @param message - Notification message.
-     * @param notificationType - Notification type
-     *
-     * @internal
-     * Limited to Microsoft-internal use
-     */
-    function showNotification(showNotificationParameters: ShowNotificationParameters): void;
-    /**
-     * @hidden
-     *
-     * Checks if the notifications capability is supported by the host
-     * @returns boolean to represent whether the notifications capability is supported
-     *
-     * @throws Error if {@linkcode app.initialize} has not successfully completed
-     *
-     * @internal
-     * Limited to Microsoft-internal use
-     */
-    function isSupported(): boolean;
-}
+/**
+ * @hidden
+ * display notification API.
+ *
+ * @param message - Notification message.
+ * @param notificationType - Notification type
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare function showNotification(showNotificationParameters: ShowNotificationParameters): void;
+/**
+ * @hidden
+ *
+ * Checks if the notifications capability is supported by the host
+ * @returns boolean to represent whether the notifications capability is supported
+ *
+ * @throws Error if {@linkcode app.initialize} has not successfully completed
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare function isSupported(): boolean;

package/dist/esm/packages/teams-js/dts/private/otherAppStateChange.d.ts

@@ -1,4 +1,5 @@
 /**
+ * @module
  * @hidden
  * @internal
  * @beta
@@ -8,74 +9,72 @@
  * *while* the developer's application is running. For example, if the developer wants to be notified
  * when another application has been installed.
  */
-export declare namespace otherAppStateChange {
-    /**
-     * @hidden
-     * @beta
-     * @internal
-     * Limited to Microsoft-internal use
-     *
-     * Represent an event that has happened with other number of applications installed on this host.
-     * (e.g. a new app has been installed)
-     */
-    interface OtherAppStateChangeEvent {
-        /** An array of app ids that this event applies to */
-        appIds: string[];
-    }
-    /**
-     * @hidden
-     * @beta
-     * @internal
-     * Limited to Microsoft-internal use
-     *
-     * A function handler that will be called whenever an event happens with some number of applications installed on this host.
-     */
-    type OtherAppStateChangeEventHandler = (event: OtherAppStateChangeEvent) => void;
-    /**
-     * @hidden
-     * @beta
-     * @internal
-     * Limited to Microsoft-internal use
-     *
-     * This function allows an app to register a handler that will receive whenever other applications are installed
-     * on the host while the developer's application is running.
-     *
-     * @param appInstallHandler - This handler will be called whenever apps are installed on the host.
-     *
-     * @throws Error if {@link app.initialize} has not successfully completed, if the platform
-     * does not support the otherAppStateChange capability, or if a valid handler is not passed to the function.
-     *
-     * @example
-     * ``` ts
-     * if (otherAppStateChange.isSupported()) {
-     *  otherAppStateChange.registerAppInstallationHandler((event: otherAppStateChange.OtherAppStateChangeEvent) => {
-     *    // code to handle the event goes here
-     *  });
-     * }
-     * ```
-     */
-    function registerAppInstallationHandler(appInstallHandler: OtherAppStateChangeEventHandler): void;
-    /**
-     * @hidden
-     * @beta
-     * @internal
-     * Limited to Microsoft-internal use
-     *
-     * This function can be called so that the handler passed to {@link registerAppInstallationHandler}
-     * will no longer receive app installation events. If this is called before registering a handler
-     * it will have no effect.
-     *
-     * @throws Error if {@link app.initialize} has not successfully completed or if the platform
-     * does not support the otherAppStateChange capability.
-     */
-    function unregisterAppInstallationHandler(): void;
-    /**
-     * Checks if the otherAppStateChange capability is supported by the host
-     * @returns boolean to represent whether the otherAppStateChange capability is supported
-     *
-     * @throws Error if {@link app.initialize} has not successfully completed
-     *
-     * @beta
-     */
-    function isSupported(): boolean;
+/**
+ * @hidden
+ * @beta
+ * @internal
+ * Limited to Microsoft-internal use
+ *
+ * Represent an event that has happened with other number of applications installed on this host.
+ * (e.g. a new app has been installed)
+ */
+export interface OtherAppStateChangeEvent {
+    /** An array of app ids that this event applies to */
+    appIds: string[];
 }
+/**
+ * @hidden
+ * @beta
+ * @internal
+ * Limited to Microsoft-internal use
+ *
+ * A function handler that will be called whenever an event happens with some number of applications installed on this host.
+ */
+export type OtherAppStateChangeEventHandler = (event: OtherAppStateChangeEvent) => void;
+/**
+ * @hidden
+ * @beta
+ * @internal
+ * Limited to Microsoft-internal use
+ *
+ * This function allows an app to register a handler that will receive whenever other applications are installed
+ * on the host while the developer's application is running.
+ *
+ * @param appInstallHandler - This handler will be called whenever apps are installed on the host.
+ *
+ * @throws Error if {@link app.initialize} has not successfully completed, if the platform
+ * does not support the otherAppStateChange capability, or if a valid handler is not passed to the function.
+ *
+ * @example
+ * ``` ts
+ * if (otherAppStateChange.isSupported()) {
+ *  otherAppStateChange.registerAppInstallationHandler((event: otherAppStateChange.OtherAppStateChangeEvent) => {
+ *    // code to handle the event goes here
+ *  });
+ * }
+ * ```
+ */
+export declare function registerAppInstallationHandler(appInstallHandler: OtherAppStateChangeEventHandler): void;
+/**
+ * @hidden
+ * @beta
+ * @internal
+ * Limited to Microsoft-internal use
+ *
+ * This function can be called so that the handler passed to {@link registerAppInstallationHandler}
+ * will no longer receive app installation events. If this is called before registering a handler
+ * it will have no effect.
+ *
+ * @throws Error if {@link app.initialize} has not successfully completed or if the platform
+ * does not support the otherAppStateChange capability.
+ */
+export declare function unregisterAppInstallationHandler(): void;
+/**
+ * Checks if the otherAppStateChange capability is supported by the host
+ * @returns boolean to represent whether the otherAppStateChange capability is supported
+ *
+ * @throws Error if {@link app.initialize} has not successfully completed
+ *
+ * @beta
+ */
+export declare function isSupported(): boolean;