@microsoft/teams-js 1.10.1-dev.0 → 1.10.1-dev.1

package/dts/private/logs.d.ts

@@ -0,0 +1,17 @@
+/**
+ * Namespace to interact with the logging part of the SDK.
+ * This object is used to send the app logs on demand to the host client
+ *
+ * @private
+ * Hide from docs
+ */
+export declare namespace logs {
+    /**
+     * @private
+     * Hide from docs
+     * ------
+     * Registers a handler for getting app log
+     * @param handler The handler to invoke to get the app log
+     */
+    function registerGetLogHandler(handler: () => string): void;
+}

package/dts/private/meetingRoom.d.ts

@@ -0,0 +1,157 @@
+import { SdkError } from '../public/interfaces';
+export declare namespace meetingRoom {
+    /**
+     * @private
+     * Hide from docs
+     *
+     * Data structure to represent a meeting room.
+     */
+    interface MeetingRoomInfo {
+        /**
+         * Endpoint id of the meeting room.
+         */
+        endpointId: string;
+        /**
+         * Device name of the meeting room.
+         */
+        deviceName: string;
+        /**
+         * Client type of the meeting room.
+         */
+        clientType: string;
+        /**
+         * Client version of the meeting room.
+         */
+        clientVersion: string;
+    }
+    /**
+     * @private
+     * Hide from docs
+     *
+     * Enum used to indicate meeting room capabilities.
+     */
+    enum Capability {
+        /**
+         * Media control capability: toggle mute.
+         */
+        toggleMute = "toggleMute",
+        /**
+         * Media control capability: toggle camera.
+         */
+        toggleCamera = "toggleCamera",
+        /**
+         * Media control capability: toggle captions.
+         */
+        toggleCaptions = "toggleCaptions",
+        /**
+         * Media control capability: volume ajustion.
+         */
+        volume = "volume",
+        /**
+         * Stage layout control capability: show gallery mode.
+         */
+        showVideoGallery = "showVideoGallery",
+        /**
+         * Stage layout control capability: show content mode.
+         */
+        showContent = "showContent",
+        /**
+         * Stage layout control capability: show content + gallery mode.
+         */
+        showVideoGalleryAndContent = "showVideoGalleryAndContent",
+        /**
+         * Stage layout control capability: show laryge gallery mode.
+         */
+        showLargeGallery = "showLargeGallery",
+        /**
+         * Stage layout control capability: show together mode.
+         */
+        showTogether = "showTogether",
+        /**
+         * Meeting control capability: leave meeting.
+         */
+        leaveMeeting = "leaveMeeting"
+    }
+    /**
+     * @private
+     * Hide from docs
+     *
+     * Data structure to represent capabilities of a meeting room.
+     */
+    interface MeetingRoomCapability {
+        /**
+         * Media control capabilities, value can be "toggleMute", "toggleCamera", "toggleCaptions", "volume".
+         */
+        mediaControls: string[];
+        /**
+         * Main stage layout control capabilities, value can be "showVideoGallery", "showContent", "showVideoGalleryAndContent", "showLargeGallery", "showTogether".
+         */
+        stageLayoutControls: string[];
+        /**
+         * Meeting control capabilities, value can be "leaveMeeting".
+         */
+        meetingControls: string[];
+    }
+    /**
+     * @private
+     * Hide from docs
+     *
+     * Data structure to represent states of a meeting room.
+     */
+    interface MeetingRoomState {
+        /**
+         * Current mute state, true: mute, false: unmute.
+         */
+        toggleMute: boolean;
+        /**
+         * Current camera state, true: camera on, false: camera off.
+         */
+        toggleCamera: boolean;
+        /**
+         * Current captions state, true: captions on, false: captions off.
+         */
+        toggleCaptions: boolean;
+        /**
+         * Current main stage layout state, value can be one of "Gallery", "Content + gallery", "Content", "Large gallery" and "Together mode".
+         */
+        stageLayout: string;
+        /**
+         * Current leaveMeeting state, true: leave, false: no-op.
+         */
+        leaveMeeting: boolean;
+    }
+    /**
+     * @private
+     * Hide from docs
+     *
+     * Fetch the meeting room info that paired with current client.
+     * @param callback Callback to invoke when the meeting room info is fetched.
+     */
+    function getPairedMeetingRoomInfo(callback: (sdkError: SdkError, meetingRoomInfo: MeetingRoomInfo) => void): void;
+    /**
+     * @private
+     * Hide from docs
+     *
+     * Send a command to paired meeting room.
+     * @param commandName The command name.
+     * @param callback Callback to invoke when the command response returns.
+     */
+    function sendCommandToPairedMeetingRoom(commandName: string, callback: (sdkError: SdkError) => void): void;
+    /**
+     * @private
+     * Hide from docs
+     *
+     * Registers a handler for meeting room capabilities update.
+     * Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
+     * @param handler The handler to invoke when the capabilities of meeting room update.
+     */
+    function registerMeetingRoomCapabilitiesUpdateHandler(handler: (capabilities: MeetingRoomCapability) => void): void;
+    /**
+     * @private
+     * Hide from docs
+     * Registers a handler for meeting room states update.
+     * Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
+     * @param handler The handler to invoke when the states of meeting room update.
+     */
+    function registerMeetingRoomStatesUpdateHandler(handler: (states: MeetingRoomState) => void): void;
+}

package/dts/private/menus.d.ts

@@ -0,0 +1,117 @@
+/**
+ * Namespace to interact with the menu-specific part of the SDK.
+ * This object is used to show View Configuration, Action Menu and Navigation Bar Menu.
+ *
+ * @private
+ * Hide from docs until feature is complete
+ */
+export declare namespace menus {
+    /**
+     * Represents information about item in View Configuration.
+     */
+    interface ViewConfiguration {
+        /**
+         * Unique identifier of view.
+         */
+        id: string;
+        /**
+         * Display title of the view.
+         */
+        title: string;
+        /**
+         * Additional information for accessibility.
+         */
+        contentDescription?: string;
+    }
+    /**
+     * Represents information about menu item for Action Menu and Navigation Bar Menu.
+     */
+    class MenuItem {
+        /**
+         * Unique identifier for the menu item.
+         */
+        id: string;
+        /**
+         * Display title of the menu item.
+         */
+        title: string;
+        /**
+         * Display icon of the menu item. The icon value must be a string having SVG icon content.
+         */
+        icon: string;
+        /**
+         * Selected state display icon of the menu item. The icon value must be a string having SVG icon content.
+         */
+        iconSelected?: string;
+        /**
+         * Additional information for accessibility.
+         */
+        contentDescription?: string;
+        /**
+         * State of the menu item
+         */
+        enabled: boolean;
+        /**
+         * Interface to show list of items on selection of menu item.
+         */
+        viewData: ViewData;
+        /**
+         * Whether the menu item is selected or not
+         */
+        selected: boolean;
+    }
+    /**
+     * Represents information about view to show on Navigation Bar Menu item selection
+     */
+    interface ViewData {
+        /**
+         * Display header title of the item list.
+         */
+        listTitle?: string;
+        /**
+         * Type of the menu item.
+         */
+        listType: MenuListType;
+        /**
+         * Array of MenuItem. Icon value will be required for all items in the list.
+         */
+        listItems: MenuItem[];
+    }
+    /**
+     * Represents information about type of list to display in Navigation Bar Menu.
+     */
+    enum MenuListType {
+        dropDown = "dropDown",
+        popOver = "popOver"
+    }
+    function initialize(): void;
+    /**
+     * Registers list of view configurations and it's handler.
+     * Handler is responsible for listening selection of View Configuration.
+     * @param viewConfig List of view configurations. Minimum 1 value is required.
+     * @param handler The handler to invoke when the user selects view configuration.
+     */
+    function setUpViews(viewConfig: ViewConfiguration[], handler: (id: string) => boolean): void;
+    /**
+     * Used to set menu items on the Navigation Bar. If icon is available, icon will be shown, otherwise title will be shown.
+     * @param items List of MenuItems for Navigation Bar Menu.
+     * @param handler The handler to invoke when the user selects menu item.
+     */
+    function setNavBarMenu(items: MenuItem[], handler: (id: string) => boolean): void;
+    interface ActionMenuParameters {
+        /**
+         * Display title for Action Menu
+         */
+        title: string;
+        /**
+         * List of MenuItems for Action Menu
+         */
+        items: MenuItem[];
+    }
+    /**
+     * Used to show Action Menu.
+     * @param params Parameters for Menu Parameters
+     * @param handler The handler to invoke when the user selects menu item.
+     */
+    function showActionMenu(params: ActionMenuParameters, handler: (id: string) => boolean): void;
+}

package/dts/private/privateAPIs.d.ts

@@ -0,0 +1,104 @@
+import { ChatMembersInformation, ShowNotificationParameters, FilePreviewParameters, TeamInstanceParameters, UserJoinedTeamsInformation, UserSettingTypes } from './interfaces';
+export declare function initializePrivateApis(): void;
+/**
+ * @private
+ * Hide from docs
+ * ------
+ * Allows an app to retrieve information of all user joined teams
+ * @param callback The callback to invoke when the {@link TeamInstanceParameters} object is retrieved.
+ * @param teamInstanceParameters OPTIONAL Flags that specify whether to scope call to favorite teams
+ */
+export declare function getUserJoinedTeams(callback: (userJoinedTeamsInformation: UserJoinedTeamsInformation) => void, teamInstanceParameters?: TeamInstanceParameters): void;
+/**
+ * @private
+ * Hide from docs
+ * ------
+ * Place the tab into full-screen mode.
+ */
+export declare function enterFullscreen(): void;
+/**
+ * @private
+ * Hide from docs
+ * ------
+ * Reverts the tab into normal-screen mode.
+ */
+export declare function exitFullscreen(): void;
+/**
+ * @private
+ * Hide from docs.
+ * ------
+ * Opens a client-friendly preview of the specified file.
+ * @param file The file to preview.
+ */
+export declare function openFilePreview(filePreviewParameters: FilePreviewParameters): void;
+/**
+ * @private
+ * Hide from docs.
+ * ------
+ * display notification API.
+ * @param message Notification message.
+ * @param notificationType Notification type
+ */
+export declare function showNotification(showNotificationParameters: ShowNotificationParameters): void;
+/**
+ * @private
+ * Hide from docs.
+ * ------
+ * Upload a custom App manifest directly to both team and personal scopes.
+ * This method works just for the first party Apps.
+ */
+export declare function uploadCustomApp(manifestBlob: Blob, onComplete?: (status: boolean, reason?: string) => void): void;
+/**
+ * @private
+ * Internal use only
+ * Sends a custom action MessageRequest to Teams 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
+ */
+export declare function sendCustomMessage(actionName: string, args?: any[], callback?: (...args: any[]) => void): void;
+/**
+ * @private
+ * Internal use only
+ * 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
+ */
+export declare function sendCustomEvent(actionName: string, args?: any[]): void;
+/**
+ * @private
+ * Internal use only
+ * 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
+ */
+export declare function registerCustomHandler(actionName: string, customHandler: (...args: any[]) => any[]): void;
+/**
+ * @private
+ * Hide from docs
+ * ------
+ * Allows an app to retrieve information of all chat members
+ * Because a malicious party run your content in a browser, this value should
+ * be used only as a hint as to who the members are and never as proof of membership.
+ * @param callback The callback to invoke when the {@link ChatMembersInformation} object is retrieved.
+ */
+export declare function getChatMembers(callback: (chatMembersInformation: ChatMembersInformation) => void): void;
+/**
+ * @private
+ * Hide from docs
+ * ------
+ * Allows an app to get the configuration setting value
+ * @param callback The callback to invoke when the value is retrieved.
+ * @param key The key for the config setting
+ */
+export declare function getConfigSetting(callback: (value: string) => void, key: string): void;
+/**
+ * @private
+ * 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
+ */
+export declare function registerUserSettingsChangeHandler(settingTypes: UserSettingTypes[], handler: (settingType: UserSettingTypes, value: any) => void): void;

package/dts/private/remoteCamera.d.ts

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

package/dts/public/appInitialization.d.ts

@@ -0,0 +1,44 @@
+export declare namespace appInitialization {
+    const Messages: {
+        AppLoaded: string;
+        Success: string;
+        Failure: string;
+        ExpectedFailure: string;
+    };
+    enum FailedReason {
+        AuthFailed = "AuthFailed",
+        Timeout = "Timeout",
+        Other = "Other"
+    }
+    enum ExpectedFailureReason {
+        PermissionError = "PermissionError",
+        NotFound = "NotFound",
+        Throttling = "Throttling",
+        Offline = "Offline",
+        Other = "Other"
+    }
+    interface IFailedRequest {
+        reason: FailedReason;
+        message?: string;
+    }
+    interface IExpectedFailureRequest {
+        reason: ExpectedFailureReason;
+        message?: string;
+    }
+    /**
+     * Notifies the frame that app has loaded and to hide the loading indicator if one is shown.
+     */
+    function notifyAppLoaded(): void;
+    /**
+     * Notifies the frame that app initialization is successful and is ready for user interaction.
+     */
+    function notifySuccess(): void;
+    /**
+     * Notifies the frame that app initialization has failed and to show an error page in its place.
+     */
+    function notifyFailure(appInitializationFailedRequest: IFailedRequest): void;
+    /**
+     * Notifies the frame that app initialized with some expected errors.
+     */
+    function notifyExpectedFailure(expectedFailureRequest: IExpectedFailureRequest): void;
+}

package/dts/public/appWindow.d.ts

@@ -0,0 +1,14 @@
+export interface IAppWindow {
+    postMessage(message: any): void;
+    addEventListener(type: string, listener: Function): void;
+}
+export declare class ChildAppWindow implements IAppWindow {
+    postMessage(message: any, onComplete?: (status: boolean, reason?: string) => void): void;
+    addEventListener(type: string, listener: (message: any) => void): void;
+}
+export declare class ParentAppWindow implements IAppWindow {
+    private static _instance;
+    static readonly Instance: IAppWindow;
+    postMessage(message: any, onComplete?: (status: boolean, reason?: string) => void): void;
+    addEventListener(type: string, listener: (message: any) => void): void;
+}