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

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

@@ -0,0 +1,107 @@
+/**
+ * @hidden
+ * Namespace to request message ports from the host application.
+ *
+ * @beta
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare namespace messageChannels {
+    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
+     *
+     * @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
+     */
+    function isSupported(): boolean;
+}

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

@@ -0,0 +1,26 @@
+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;
+}

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

@@ -0,0 +1,81 @@
+/**
+ * @hidden
+ * @internal
+ * @beta
+ * Limited to Microsoft-internal use
+ *
+ * This capability contains the APIs for handling events that happen to other applications on the host
+ * *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;
+}

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

@@ -0,0 +1,60 @@
+import { FilePreviewParameters, UserSettingTypes } from './interfaces';
+export declare function uploadCustomApp(manifestBlob: Blob, onComplete?: (status: boolean, reason?: string) => void): void;
+/**
+ * @hidden
+ * Sends a custom action MessageRequest to host or parent window
+ *
+ * @param actionName - Specifies name of the custom action to be sent
+ * @param args - Specifies additional arguments passed to the action
+ * @param callback - Optionally specify a callback to receive response parameters from the parent
+ * @returns id of sent message
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare function sendCustomMessage(actionName: string, args?: any[], callback?: (...args: any[]) => void): void;
+/**
+ * @hidden
+ * Sends a custom action MessageEvent to a child iframe/window, only if you are not using auth popup.
+ * Otherwise it will go to the auth popup (which becomes the child)
+ *
+ * @param actionName - Specifies name of the custom action to be sent
+ * @param args - Specifies additional arguments passed to the action
+ * @returns id of sent message
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare function sendCustomEvent(actionName: string, args?: any[]): void;
+/**
+ * @hidden
+ * Adds a handler for an action sent by a child window or parent window
+ *
+ * @param actionName - Specifies name of the action message to handle
+ * @param customHandler - The callback to invoke when the action message is received. The return value is sent to the child
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare function registerCustomHandler(actionName: string, customHandler: (...args: any[]) => any[]): void;
+/**
+ * @hidden
+ * register a handler to be called when a user setting changes. The changed setting type & value is provided in the callback.
+ *
+ * @param settingTypes - List of user setting changes to subscribe
+ * @param handler - When a subscribed setting is updated this handler is called
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare function registerUserSettingsChangeHandler(settingTypes: UserSettingTypes[], handler: (settingType: UserSettingTypes, value: any) => void): void;
+/**
+ * @hidden
+ * Opens a client-friendly preview of the specified file.
+ *
+ * @param file - The file to preview.
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare function openFilePreview(filePreviewParameters: FilePreviewParameters): void;

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

@@ -0,0 +1,298 @@
+import { SdkError } from '../public/interfaces';
+export declare namespace remoteCamera {
+    /**
+     * @hidden
+     * Data structure to represent patricipant details needed to request control of camera.
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    interface Participant {
+        /**
+         * @hidden
+         * Id of participant.
+         *
+         * @internal
+         * Limited to Microsoft-internal use
+         */
+        id: string;
+        /**
+         * @hidden
+         * Display name of participant.
+         *
+         * @internal
+         * Limited to Microsoft-internal use
+         */
+        displayName?: string;
+        /**
+         * @hidden
+         * Active indicates whether the participant's device is actively being controlled.
+         *
+         * @internal
+         * Limited to Microsoft-internal use
+         */
+        active?: boolean;
+    }
+    /**
+     * @hidden
+     * Enum used to indicate possible camera control commands.
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    enum ControlCommand {
+        Reset = "Reset",
+        ZoomIn = "ZoomIn",
+        ZoomOut = "ZoomOut",
+        PanLeft = "PanLeft",
+        PanRight = "PanRight",
+        TiltUp = "TiltUp",
+        TiltDown = "TiltDown"
+    }
+    /**
+     * @hidden
+     * Data structure to indicate the current state of the device.
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    interface DeviceState {
+        /**
+         * @hidden
+         * All operation are available to apply.
+         *
+         * @internal
+         * Limited to Microsoft-internal use
+         */
+        available: boolean;
+        /**
+         * @hidden
+         * Either camera doesnt support to get state or It unable to apply command.
+         *
+         * @internal
+         * Limited to Microsoft-internal use
+         */
+        error: boolean;
+        /**
+         * @hidden
+         * Reset max out or already applied. Client Disable Reset.
+         *
+         * @internal
+         * Limited to Microsoft-internal use
+         */
+        reset: boolean;
+        /**
+         * @hidden
+         * ZoomIn maxed out.
+         *
+         * @internal
+         * Limited to Microsoft-internal use
+         */
+        zoomIn: boolean;
+        /**
+         * @hidden
+         * ZoomOut maxed out.
+         *
+         * @internal
+         * Limited to Microsoft-internal use
+         */
+        zoomOut: boolean;
+        /**
+         * @hidden
+         * PanLeft reached max left.
+         *
+         * @internal
+         * Limited to Microsoft-internal use
+         */
+        panLeft: boolean;
+        /**
+         * @hidden
+         * PanRight reached max right.
+         *
+         * @internal
+         * Limited to Microsoft-internal use
+         */
+        panRight: boolean;
+        /**
+         * @hidden
+         * TiltUp reached top.
+         *
+         * @internal
+         * Limited to Microsoft-internal use
+         */
+        tiltUp: boolean;
+        /**
+         * @hidden
+         * TiltDown reached bottom.
+         *
+         * @internal Limited to Microsoft-internal use
+         */
+        tiltDown: boolean;
+    }
+    /**
+     * @hidden
+     * Enum used to indicate the reason for the error.
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    enum ErrorReason {
+        CommandResetError = 0,
+        CommandZoomInError = 1,
+        CommandZoomOutError = 2,
+        CommandPanLeftError = 3,
+        CommandPanRightError = 4,
+        CommandTiltUpError = 5,
+        CommandTiltDownError = 6,
+        SendDataError = 7
+    }
+    /**
+     * @hidden
+     * Data structure to indicate the status of the current session.
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    interface SessionStatus {
+        /**
+         * @hidden
+         * Whether the far-end user is controlling a  device.
+         *
+         * @internal
+         * Limited to Microsoft-internal use
+         */
+        inControl: boolean;
+        /**
+         * @hidden
+         * Reason the  control session was terminated.
+         *
+         * @internal
+         * Limited to Microsoft-internal use
+         */
+        terminatedReason?: SessionTerminatedReason;
+    }
+    /**
+     * @hidden
+     * Enum used to indicate the reason the session was terminated.
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    enum SessionTerminatedReason {
+        None = 0,
+        ControlDenied = 1,
+        ControlNoResponse = 2,
+        ControlBusy = 3,
+        AckTimeout = 4,
+        ControlTerminated = 5,
+        ControllerTerminated = 6,
+        DataChannelError = 7,
+        ControllerCancelled = 8,
+        ControlDisabled = 9,
+        ControlTerminatedToAllowOtherController = 10
+    }
+    /**
+     * @hidden
+     * Fetch a list of the participants with controllable-cameras in a meeting.
+     *
+     * @param callback - Callback contains 2 parameters, error and participants.
+     * error can either contain an error of type SdkError, incase of an error, or null when fetch is successful
+     * participants can either contain an array of Participant objects, incase of a successful fetch or null when it fails
+     * participants: object that contains an array of participants with controllable-cameras
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    function getCapableParticipants(callback: (error: SdkError | null, participants: Participant[] | null) => void): void;
+    /**
+     * @hidden
+     * Request control of a participant's camera.
+     *
+     * @param participant - Participant specifies the participant to send the request for camera control.
+     * @param callback - Callback contains 2 parameters, error and requestResponse.
+     * error can either contain an error of type SdkError, incase of an error, or null when fetch is successful
+     * requestResponse can either contain the true/false value, incase of a successful request or null when it fails
+     * requestResponse: True means request was accepted and false means request was denied
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    function requestControl(participant: Participant, callback: (error: SdkError | null, requestResponse: boolean | null) => void): void;
+    /**
+     * @hidden
+     * Send control command to the participant's camera.
+     *
+     * @param ControlCommand - ControlCommand specifies the command for controling the camera.
+     * @param callback - Callback to invoke when the command response returns.
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    function sendControlCommand(ControlCommand: ControlCommand, callback: (error: SdkError | null) => void): void;
+    /**
+     * @hidden
+     * Terminate the remote  session
+     *
+     * @param callback - Callback to invoke when the command response returns.
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    function terminateSession(callback: (error: SdkError | null) => void): void;
+    /**
+     * @hidden
+     * Registers a handler for change in participants with controllable-cameras.
+     * Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
+     *
+     * @param handler - The handler to invoke when the list of participants with controllable-cameras changes.
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    function registerOnCapableParticipantsChangeHandler(handler: (participantChange: Participant[]) => void): void;
+    /**
+     * @hidden
+     * Registers a handler for error.
+     * Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
+     *
+     * @param handler - The handler to invoke when there is an error from the camera handler.
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    function registerOnErrorHandler(handler: (error: ErrorReason) => void): void;
+    /**
+     * @hidden
+     * Registers a handler for device state change.
+     * Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
+     *
+     * @param handler - The handler to invoke when the controlled device changes state.
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    function registerOnDeviceStateChangeHandler(handler: (deviceStateChange: DeviceState) => void): void;
+    /**
+     * @hidden
+     * Registers a handler for session status change.
+     * Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
+     *
+     * @param handler - The handler to invoke when the current session status changes.
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    function registerOnSessionStatusChangeHandler(handler: (sessionStatusChange: SessionStatus) => void): void;
+    /**
+     * @hidden
+     *
+     * Checks if the remoteCamera capability is supported by the host
+     * @returns boolean to represent whether the remoteCamera capability is supported
+     *
+     * @throws Error if {@linkcode app.initialize} has not successfully completed
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    function isSupported(): boolean;
+}

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

@@ -0,0 +1,116 @@
+import { SdkError } from '../public/interfaces';
+import { TeamInstanceParameters, UserJoinedTeamsInformation } from './interfaces';
+export declare namespace teams {
+    enum ChannelType {
+        Regular = 0,
+        Private = 1,
+        Shared = 2
+    }
+    /**
+     * @hidden
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    interface ChannelInfo {
+        siteUrl: string;
+        objectId: string;
+        folderRelativeUrl: string;
+        displayName: string;
+        channelType: ChannelType;
+    }
+    /**
+     * @hidden
+     * Get a list of channels belong to a Team
+     *
+     * @param groupId - a team's objectId
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    function getTeamChannels(groupId: string, callback: (error: SdkError, channels: ChannelInfo[]) => void): void;
+    /**
+     * @hidden
+     * Allow 1st party apps to call this function when they receive migrated errors to inform the Hub/Host to refresh the siteurl
+     * when site admin renames siteurl.
+     *
+     * @param threadId - ID of the thread where the app entity will be created; if threadId is not
+     * provided, the threadId from route params will be used.
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    function refreshSiteUrl(threadId: string, callback: (error: SdkError) => void): void;
+    /**
+     * @hidden
+     *
+     * Checks if teams capability is supported by the host
+     * @returns boolean to represent whether the teams capability is supported
+     *
+     * @throws Error if {@linkcode app.initialize} has not successfully completed
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    function isSupported(): boolean;
+    /**
+     * @hidden
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    namespace fullTrust {
+        /**
+         * @hidden
+         * @internal
+         * Limited to Microsoft-internal use
+         */
+        namespace joinedTeams {
+            /**
+             * @hidden
+             * Allows an app to retrieve information of all user joined teams
+             *
+             * @param teamInstanceParameters - Optional flags that specify whether to scope call to favorite teams
+             * @returns Promise that resolves with information about the user joined teams or rejects with an error when the operation has completed
+             *
+             * @internal
+             * Limited to Microsoft-internal use
+             */
+            function getUserJoinedTeams(teamInstanceParameters?: TeamInstanceParameters): Promise<UserJoinedTeamsInformation>;
+            /**
+             * @hidden
+             *
+             * Checks if teams.fullTrust.joinedTeams capability is supported by the host
+             * @returns boolean to represent whether the teams.fullTrust.joinedTeams capability is supported
+             *
+             * @throws Error if {@linkcode app.initialize} has not successfully completed
+             *
+             * @internal
+             * Limited to Microsoft-internal use
+             */
+            function isSupported(): boolean;
+        }
+        /**
+         * @hidden
+         * Allows an app to get the configuration setting value
+         *
+         * @param key - The key for the config setting
+         * @returns Promise that resolves with the value for the provided configuration setting or rejects with an error when the operation has completed
+         *
+         * @internal
+         * Limited to Microsoft-internal use
+         */
+        function getConfigSetting(key: string): Promise<string>;
+        /**
+         * @hidden
+         *
+         * Checks if teams.fullTrust capability is supported by the host
+         * @returns boolean to represent whether the teams.fullTrust capability is supported
+         *
+         * @throws Error if {@linkcode app.initialize} has not successfully completed
+         *
+         * @internal
+         * Limited to Microsoft-internal use
+         */
+        function isSupported(): boolean;
+    }
+}