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

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

@@ -1,298 +1,303 @@
+/**
+ * @hidden
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ * @module
+ */
 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
+ */
+export interface Participant {
     /**
      * @hidden
-     * Data structure to represent patricipant details needed to request control of camera.
+     * Id of participant.
      *
      * @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;
-    }
+    id: string;
     /**
      * @hidden
-     * Enum used to indicate possible camera control commands.
+     * Display name of participant.
      *
      * @internal
      * Limited to Microsoft-internal use
      */
-    enum ControlCommand {
-        Reset = "Reset",
-        ZoomIn = "ZoomIn",
-        ZoomOut = "ZoomOut",
-        PanLeft = "PanLeft",
-        PanRight = "PanRight",
-        TiltUp = "TiltUp",
-        TiltDown = "TiltDown"
-    }
+    displayName?: string;
     /**
      * @hidden
-     * Data structure to indicate the current state of the device.
+     * Active indicates whether the participant's device is actively being controlled.
      *
      * @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;
-    }
+    active?: boolean;
+}
+/**
+ * @hidden
+ * Enum used to indicate possible camera control commands.
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare 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
+ */
+export interface DeviceState {
     /**
      * @hidden
-     * Enum used to indicate the reason for the error.
+     * All operation are available to apply.
      *
      * @internal
      * Limited to Microsoft-internal use
      */
-    enum ErrorReason {
-        CommandResetError = 0,
-        CommandZoomInError = 1,
-        CommandZoomOutError = 2,
-        CommandPanLeftError = 3,
-        CommandPanRightError = 4,
-        CommandTiltUpError = 5,
-        CommandTiltDownError = 6,
-        SendDataError = 7
-    }
+    available: boolean;
     /**
      * @hidden
-     * Data structure to indicate the status of the current session.
+     * Either camera doesnt support to get state or It unable to apply command.
      *
      * @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;
-    }
+    error: boolean;
     /**
      * @hidden
-     * Enum used to indicate the reason the session was terminated.
+     * Reset max out or already applied. Client Disable Reset.
      *
      * @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
-    }
+    reset: boolean;
     /**
      * @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
+     * ZoomIn maxed out.
      *
      * @internal
      * Limited to Microsoft-internal use
      */
-    function getCapableParticipants(callback: (error: SdkError | null, participants: Participant[] | null) => void): void;
+    zoomIn: boolean;
     /**
      * @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
+     * ZoomOut maxed out.
      *
      * @internal
      * Limited to Microsoft-internal use
      */
-    function requestControl(participant: Participant, callback: (error: SdkError | null, requestResponse: boolean | null) => void): void;
+    zoomOut: boolean;
     /**
      * @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.
+     * PanLeft reached max left.
      *
      * @internal
      * Limited to Microsoft-internal use
      */
-    function sendControlCommand(ControlCommand: ControlCommand, callback: (error: SdkError | null) => void): void;
+    panLeft: boolean;
     /**
      * @hidden
-     * Terminate the remote  session
-     *
-     * @param callback - Callback to invoke when the command response returns.
+     * PanRight reached max right.
      *
      * @internal
      * Limited to Microsoft-internal use
      */
-    function terminateSession(callback: (error: SdkError | null) => void): void;
+    panRight: boolean;
     /**
      * @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.
+     * TiltUp reached top.
      *
      * @internal
      * Limited to Microsoft-internal use
      */
-    function registerOnCapableParticipantsChangeHandler(handler: (participantChange: Participant[]) => void): void;
+    tiltUp: boolean;
     /**
      * @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.
+     * TiltDown reached bottom.
      *
-     * @internal
-     * Limited to Microsoft-internal use
+     * @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;
+    tiltDown: boolean;
+}
+/**
+ * @hidden
+ * Enum used to indicate the reason for the error.
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare 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
+ */
+export interface SessionStatus {
     /**
      * @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.
+     * Whether the far-end user is controlling a  device.
      *
      * @internal
      * Limited to Microsoft-internal use
      */
-    function registerOnSessionStatusChangeHandler(handler: (sessionStatusChange: SessionStatus) => void): void;
+    inControl: boolean;
     /**
      * @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
+     * Reason the  control session was terminated.
      *
      * @internal
      * Limited to Microsoft-internal use
      */
-    function isSupported(): boolean;
+    terminatedReason?: SessionTerminatedReason;
+}
+/**
+ * @hidden
+ * Enum used to indicate the reason the session was terminated.
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare 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
+ */
+export declare 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
+ */
+export declare 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
+ */
+export declare 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
+ */
+export declare 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
+ */
+export declare 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
+ */
+export declare 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
+ */
+export declare 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
+ */
+export declare 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
+ */
+export declare function isSupported(): boolean;

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

@@ -0,0 +1,31 @@
+/**
+ * @module
+ * @hidden
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+import * as joinedTeams from './joinedTeams';
+/**
+ * @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
+ */
+export declare 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
+ */
+export declare function isSupported(): boolean;
+export { joinedTeams };

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

@@ -0,0 +1,30 @@
+/**
+ * @module
+ * @hidden
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+import { TeamInstanceParameters, UserJoinedTeamsInformation } from '../../interfaces';
+/**
+ * @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
+ */
+export declare 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
+ */
+export declare function isSupported(): boolean;

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

@@ -0,0 +1,63 @@
+/**
+ * @module
+ * @hidden
+ * Module to interact with the `teams` specific part of the SDK.
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+import { SdkError } from '../../public/interfaces';
+import * as fullTrust from './fullTrust/fullTrust';
+export declare enum ChannelType {
+    Regular = 0,
+    Private = 1,
+    Shared = 2
+}
+/**
+ * @hidden
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export 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
+ */
+export declare 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
+ */
+export declare 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
+ */
+export declare function isSupported(): boolean;
+export { fullTrust };