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

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

@@ -0,0 +1,176 @@
+import { TabInstance } from '../public/interfaces';
+/**
+ * @hidden
+ * @internal
+ * @beta
+ * Limited to Microsoft-internal use
+ *
+ * This capability allows an app to associate apps with a host entity, such as a Teams channel or chat, and configure them as needed.
+ */
+export declare namespace hostEntity {
+    export enum AppTypes {
+        edu = "EDU"
+    }
+    /**
+     * Id of the teams entity like channel, chat
+     */
+    interface TeamsEntityId {
+        threadId: string;
+    }
+    /**
+     * Id of message in which channel meeting is created
+     */
+    export interface TeamsChannelMeetingEntityIds extends TeamsEntityId {
+        parentMessageId: string;
+    }
+    /**
+     * Id of the host entity
+     */
+    export type HostEntityIds = TeamsEntityId | TeamsChannelMeetingEntityIds;
+    /**
+     * @hidden
+     * @internal
+     * @beta
+     * Limited to Microsoft-internal use
+     *
+     * CRUD operations for tabs associated with apps
+     */
+    export namespace tab {
+        /**
+         * Represents information about a static tab instance
+         */
+        interface StaticTabInstance extends TabInstance {
+            tabType: 'StaticTab';
+        }
+        /**
+         * Represents information about a configurable tab instance
+         */
+        interface ConfigurableTabInstance extends TabInstance {
+            tabType: 'ConfigurableTab';
+        }
+        /**
+         * Represents information about a tab instance associated with a host entity like chat, channel or meeting. Cab be a configurable tab or static tab.
+         */
+        type HostEntityTabInstance = StaticTabInstance | ConfigurableTabInstance;
+        /**
+         * Represents all tabs associated with a host entity like chat, channel or meeting
+         */
+        interface HostEntityTabInstances {
+            allTabs: HostEntityTabInstance[];
+        }
+        /**
+         * @hidden
+         * @internal
+         * @beta
+         * Limited to Microsoft-internal use
+         *
+         * Launches host-owned UI that lets a user select an app, installs it if required,
+         * runs through app configuration if required, and then associates the app with the threadId provided
+         *
+         * @param hostEntityIds Ids of the host entity like channel, chat or meeting
+         *
+         * @param appTypes What type of applications to show the user. If EDU is passed as appType, only apps supported by EDU tenant are shown.
+         * If no value is passed, all apps are shown.
+         *
+         * @returns The HostEntityTabInstance of the newly associated app
+         *
+         * @throws Error if host does not support this capability, library as not been initialized successfully, input parameters are invalid, user cancels operation or installing
+         * or configuring or adding tab fails
+         */
+        function addAndConfigure(hostEntityIds: HostEntityIds, appTypes?: AppTypes[]): Promise<HostEntityTabInstance>;
+        /**
+         * @hidden
+         * @internal
+         * @beta
+         * Limited to Microsoft-internal use
+         *
+         * Returns all tab instances associated with a host entity
+         *
+         * @param hostEntityIds Ids of the host entity like channel, chat or meeting
+         *
+         * @returns Object with array of HostEntityTabInstance's associated with a host entity
+         *
+         * @throws Error if host does not support this capability, library as not been initialized successfully, input parameters are invalid or fetching tabs fails
+         */
+        function getAll(hostEntityIds: HostEntityIds): Promise<HostEntityTabInstances>;
+        /**
+         * @hidden
+         * @internal
+         * @beta
+         * Limited to Microsoft-internal use
+         *
+         * Launches host-owned UI that lets a user re-configure the contentUrl of the tab
+         *
+         * @param tab Configurable tab instance that needs to be updated
+         *
+         * @param hostEntityIds Ids of the host entity like channel, chat or meeting
+         *
+         * @returns The HostEntityTabInstance of the updated tab
+         *
+         * @throws Error if host does not support this capability, library as not been initialized successfully, input parameters are invalid, user cancels operation,
+         * re-configuring tab fails or if tab is a static tab
+         */
+        function reconfigure(tab: ConfigurableTabInstance, hostEntityIds: HostEntityIds): Promise<ConfigurableTabInstance>;
+        /**
+         * @hidden
+         * @internal
+         * @beta
+         * Limited to Microsoft-internal use
+         *
+         * Launches host-owned UI that lets a user rename the tab
+         *
+         * @param tab Configurable tab instance that needs to be updated
+         *
+         * @param hostEntityIds Ids of the host entity like channel, chat or meeting
+         *
+         * @returns The HostEntityTabInstance of the updated tab
+         *
+         * @throws Error if host does not support this capability, library as not been initialized successfully, input parameters are invalid, user cancels operation,
+         * re-naming tab fails or if tab is a static tab
+         */
+        function rename(tab: ConfigurableTabInstance, hostEntityIds: HostEntityIds): Promise<ConfigurableTabInstance>;
+        /**
+         * @hidden
+         * @internal
+         * @beta
+         * Limited to Microsoft-internal use
+         *
+         * Launches host-owned UI that lets a user remove the tab
+         *
+         * @param tab tab instance that needs to be updated. Can be static tab or configurable tab.
+         *
+         * @param hostEntityIds Ids of the host entity like channel, chat or meeting
+         *
+         * @returns Boolean. Returns true if removing tab was successful
+         *
+         * @throws Error if host does not support this capability, library as not been initialized successfully, input parameters are invalid, user cancels operation or
+         * removing tab fails
+         */
+        function remove(tab: HostEntityTabInstance, hostEntityIds: HostEntityIds): Promise<boolean>;
+        /**
+         * @hidden
+         * @internal
+         * @beta
+         * Limited to Microsoft-internal use
+         *
+         * Checks if the hostEntity.tab capability is supported by the host
+         * @returns boolean to represent whether the histEntity and hostEntity.tab capability is supported
+         *
+         * @throws Error if {@linkcode app.initialize} has not successfully completed
+         */
+        function isSupported(): boolean;
+    }
+    /**
+     * @hidden
+     * @internal
+     * @beta
+     * Limited to Microsoft-internal use
+     *
+     * Checks if the hostEntity capability is supported by the host
+     * @returns boolean to represent whether the hostEntity capability is supported
+     *
+     * @throws Error if {@linkcode app.initialize} has not successfully completed
+     */
+    export function isSupported(): boolean;
+    export {};
+}

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

@@ -0,0 +1,20 @@
+export { logs } from './logs';
+export { ChatMembersInformation, FilePreviewParameters, NotificationTypes, ShowNotificationParameters, TeamInstanceParameters, ThreadMember, UserJoinedTeamsInformation, ViewerActionTypes, UserSettingTypes, } from './interfaces';
+export { sendCustomMessage, sendCustomEvent, registerCustomHandler, uploadCustomApp, registerUserSettingsChangeHandler, openFilePreview, } from './privateAPIs';
+export { conversations, OpenConversationRequest } from './conversations';
+export { copilot } from './copilot';
+export { externalAppAuthentication } from './externalAppAuthentication';
+export { externalAppAuthenticationForCEA } from './externalAppAuthenticationForCEA';
+export { externalAppCardActions } from './externalAppCardActions';
+export { externalAppCardActionsForCEA } from './externalAppCardActionsForCEA';
+export { externalAppCommands } from './externalAppCommands';
+export { files } from './files';
+export { meetingRoom } from './meetingRoom';
+export { messageChannels } from './messageChannels';
+export { notifications } from './notifications';
+export { otherAppStateChange } from './otherAppStateChange';
+export { remoteCamera } from './remoteCamera';
+export { appEntity } from './appEntity';
+export { teams } from './teams';
+export { videoEffectsEx } from './videoEffectsEx';
+export { hostEntity } from './hostEntity';

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

@@ -0,0 +1,250 @@
+import { FileOpenPreference, TeamInformation } from '../public/interfaces';
+/**
+ * @hidden
+ *
+ * Information about all members in a chat
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export interface ChatMembersInformation {
+    members: ThreadMember[];
+}
+/**
+ * @hidden
+ *
+ * Information about a chat member
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export interface ThreadMember {
+    /**
+     * @hidden
+     * The member's user principal name in the current tenant.
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    upn: string;
+}
+/**
+ * @hidden
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare enum NotificationTypes {
+    fileDownloadStart = "fileDownloadStart",
+    fileDownloadComplete = "fileDownloadComplete"
+}
+/**
+ * @hidden
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export interface ShowNotificationParameters {
+    message: string;
+    notificationType: NotificationTypes;
+}
+/**
+ * @hidden
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare enum ViewerActionTypes {
+    view = "view",
+    edit = "edit",
+    editNew = "editNew"
+}
+/**
+ * @hidden
+ *
+ * User setting changes that can be subscribed to
+ */
+export declare enum UserSettingTypes {
+    /**
+     * @hidden
+     * Use this key to subscribe to changes in user's file open preference
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    fileOpenPreference = "fileOpenPreference",
+    /**
+     * @hidden
+     * Use this key to subscribe to theme changes
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    theme = "theme"
+}
+/**
+ * @hidden
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export interface FilePreviewParameters {
+    /**
+     * @hidden
+     * The developer-defined unique ID for the file.
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    entityId?: string;
+    /**
+     * @hidden
+     * The display name of the file.
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    title?: string;
+    /**
+     * @hidden
+     * An optional description of the file.
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    description?: string;
+    /**
+     * @hidden
+     * The file extension; e.g. pptx, docx, etc.
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    type: string;
+    /**
+     * @hidden
+     * The size of the file in bytes.
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    sizeInBytes?: number;
+    /**
+     * @hidden
+     * A url to the source of the file, used to open the content in the user's default browser
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    objectUrl: string;
+    /**
+     * @hidden
+     * Optional; an alternate self-authenticating url used to preview the file in Mobile clients and offer it for download by the user
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    downloadUrl?: string;
+    /**
+     * @hidden
+     * Optional; an alternate url optimized for previewing the file in web and desktop clients
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    webPreviewUrl?: string;
+    /**
+     * @hidden
+     * Optional; an alternate url that allows editing of the file in web and desktop clients
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    webEditUrl?: string;
+    /**
+     * @hidden
+     * Optional; the base url of the site where the file is hosted
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    baseUrl?: string;
+    /**
+     * @hidden
+     * Deprecated; prefer using {@linkcode viewerAction} instead
+     * Optional; indicates whether the file should be opened in edit mode
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    editFile?: boolean;
+    /**
+     * @hidden
+     * Optional; the developer-defined unique ID for the sub-entity to return to when the file stage closes.
+     * This field should be used to restore to a specific state within an entity, such as scrolling to or activating a specific piece of content.
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    subEntityId?: string;
+    /**
+     * @hidden
+     * Optional; indicates the mode in which file should be opened. Takes precedence over edit mode.
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    viewerAction?: ViewerActionTypes;
+    /**
+     * @hidden
+     * Optional; indicates how user prefers to open the file
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    fileOpenPreference?: FileOpenPreference;
+    /**
+     * @hidden
+     * Optional; id required to enable conversation button in files. Will be channel id in case file is shared in a channel or the chat id in p2p chat case.
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    conversationId?: string;
+}
+/**
+ * @hidden
+ *
+ * Query parameters used when fetching team information
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export interface TeamInstanceParameters {
+    /**
+     * @hidden
+     * Flag allowing to select favorite teams only
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    favoriteTeamsOnly?: boolean;
+}
+/**
+ * @hidden
+ *
+ * Information on userJoined Teams
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export interface UserJoinedTeamsInformation {
+    /**
+     * @hidden
+     * List of team information
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    userJoinedTeams: TeamInformation[];
+}

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

@@ -0,0 +1,25 @@
+export declare namespace logs {
+    /**
+     * @hidden
+     *
+     * Registers a handler for getting app log
+     *
+     * @param handler - The handler to invoke to get the app log
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    function registerGetLogHandler(handler: () => string): void;
+    /**
+     * @hidden
+     *
+     * Checks if the logs capability is supported by the host
+     * @returns boolean to represent whether the logs 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/meetingRoom.d.ts

@@ -0,0 +1,203 @@
+export declare namespace meetingRoom {
+    /**
+     * @hidden
+     *
+     * Data structure to represent a meeting room.
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    export interface MeetingRoomInfo {
+        /**
+         * @hidden
+         * Endpoint id of the meeting room.
+         *
+         * @internal
+         * Limited to Microsoft-internal use
+         */
+        endpointId: string;
+        /**
+         * @hidden
+         * Device name of the meeting room.
+         *
+         * @internal
+         * Limited to Microsoft-internal use
+         */
+        deviceName: string;
+        /**
+         * @hidden
+         * Client type of the meeting room.
+         *
+         * @internal
+         * Limited to Microsoft-internal use
+         */
+        clientType: string;
+        /**
+         * @hidden
+         * Client version of the meeting room.
+         *
+         * @internal
+         * Limited to Microsoft-internal use
+         */
+        clientVersion: string;
+    }
+    /**
+     * @hidden
+     * Type of Media control capabilities of a meeting room.
+     */
+    type MediaControls = 'toggleMute' | 'toggleCamera' | 'toggleCaptions' | 'volume';
+    /**
+     * @hidden
+     * Types of Stage Layout control capabilities of a meeting room.
+     */
+    type StageLayoutControls = 'showVideoGallery' | 'showContent' | 'showVideoGalleryAndContent' | 'showLargeGallery' | 'showTogether';
+    /**
+     * @hidden
+     * Types of Meeting Control capabilities of a meeting room.
+     */
+    type MeetingControls = 'leaveMeeting';
+    /**
+     * @hidden
+     * Types of Stage Layout State of a meeting room.
+     */
+    type StageLayoutStates = 'Gallery' | 'Content + gallery' | 'Content' | 'Large gallery' | 'Together mode';
+    /**
+     * @hidden
+     * Data structure to represent capabilities of a meeting room.
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    export interface MeetingRoomCapability {
+        /**
+         * @hidden
+         * Media control capabilities, value can be "toggleMute", "toggleCamera", "toggleCaptions", "volume".
+         *
+         * @internal
+         * Limited to Microsoft-internal use
+         */
+        mediaControls: MediaControls[];
+        /**
+         * @hidden
+         * Main stage layout control capabilities, value can be "showVideoGallery", "showContent", "showVideoGalleryAndContent", "showLargeGallery", "showTogether".
+         *
+         * @internal
+         * Limited to Microsoft-internal use
+         */
+        stageLayoutControls: StageLayoutControls[];
+        /**
+         * @hidden
+         * Meeting control capabilities, value can be "leaveMeeting".
+         *
+         * @internal
+         * Limited to Microsoft-internal use
+         */
+        meetingControls: MeetingControls[];
+    }
+    /**
+     * @hidden
+     * Data structure to represent states of a meeting room.
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    export interface MeetingRoomState {
+        /**
+         * @hidden
+         * Current mute state, true: mute, false: unmute.
+         *
+         * @internal
+         * Limited to Microsoft-internal use
+         */
+        toggleMute: boolean;
+        /**
+         * @hidden
+         * Current camera state, true: camera on, false: camera off.
+         *
+         * @internal
+         * Limited to Microsoft-internal use
+         */
+        toggleCamera: boolean;
+        /**
+         * @hidden
+         * Current captions state, true: captions on, false: captions off.
+         *
+         * @internal
+         * Limited to Microsoft-internal use
+         */
+        toggleCaptions: boolean;
+        /**
+         * @hidden
+         * Current main stage layout state, value can be one of "Gallery", "Content + gallery", "Content", "Large gallery" and "Together mode".
+         *
+         * @internal
+         * Limited to Microsoft-internal use
+         */
+        stageLayout: StageLayoutStates;
+        /**
+         * @hidden
+         * Current leaveMeeting state, true: leave, false: no-op.
+         *
+         * @internal
+         * Limited to Microsoft-internal use
+         */
+        leaveMeeting: boolean;
+    }
+    /**
+     * @hidden
+     * Fetch the meeting room info that paired with current client.
+     *
+     * @returns Promise resolved with meeting room info or rejected with SdkError value
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    export function getPairedMeetingRoomInfo(): Promise<MeetingRoomInfo>;
+    /**
+     * @hidden
+     * Send a command to paired meeting room.
+     *
+     * @param commandName The command name.
+     * @returns Promise resolved upon completion or rejected with SdkError value
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    export function sendCommandToPairedMeetingRoom(commandName: string): Promise<void>;
+    /**
+     * @hidden
+     * 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.
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    export function registerMeetingRoomCapabilitiesUpdateHandler(handler: (capabilities: MeetingRoomCapability) => void): void;
+    /**
+     * @hidden
+     * 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.
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    export function registerMeetingRoomStatesUpdateHandler(handler: (states: MeetingRoomState) => void): void;
+    /**
+     * @hidden
+     *
+     * Checks if the meetingRoom capability is supported by the host
+     * @returns boolean to represent whether the meetingRoom capability is supported
+     *
+     * @throws Error if {@linkcode app.initialize} has not successfully completed
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    export function isSupported(): boolean;
+    export {};
+}