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

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

@@ -0,0 +1,221 @@
+/**
+ * APIs involving Live Share, a framework for building real-time collaborative apps.
+ * For more information, visit https://aka.ms/teamsliveshare
+ *
+ * @see LiveShareHost
+ */
+export declare namespace liveShare {
+    /**
+     * @hidden
+     * The meeting roles of a user.
+     * Used in Live Share for its role verification feature.
+     * For more information, visit https://learn.microsoft.com/microsoftteams/platform/apps-in-teams-meetings/teams-live-share-capabilities?tabs=javascript#role-verification-for-live-data-structures
+     */
+    enum UserMeetingRole {
+        /**
+         * Guest role.
+         */
+        guest = "Guest",
+        /**
+         * Attendee role.
+         */
+        attendee = "Attendee",
+        /**
+         * Presenter role.
+         */
+        presenter = "Presenter",
+        /**
+         * Organizer role.
+         */
+        organizer = "Organizer"
+    }
+    /**
+     * @hidden
+     * State of the current Live Share session's Fluid container.
+     * This is used internally by the `LiveShareClient` when joining a Live Share session.
+     */
+    enum ContainerState {
+        /**
+         * The call to `LiveShareHost.setContainerId()` successfully created the container mapping
+         * for the current Live Share session.
+         */
+        added = "Added",
+        /**
+         * A container mapping for the current Live Share session already exists.
+         * This indicates to Live Share that a new container does not need be created.
+         */
+        alreadyExists = "AlreadyExists",
+        /**
+         * The call to `LiveShareHost.setContainerId()` failed to create the container mapping.
+         * This happens when another client has already set the container ID for the session.
+         */
+        conflict = "Conflict",
+        /**
+         * A container mapping for the current Live Share session does not yet exist.
+         * This indicates to Live Share that a new container should be created.
+         */
+        notFound = "NotFound"
+    }
+    /**
+     * @hidden
+     * Returned from `LiveShareHost.getFluidContainerId()` and `LiveShareHost.setFluidContainerId`.
+     * This response specifies the container mapping information for the current Live Share session.
+     */
+    interface IFluidContainerInfo {
+        /**
+         * State of the containerId mapping.
+         */
+        containerState: ContainerState;
+        /**
+         * ID of the container to join for the meeting. Undefined if the container hasn't been
+         * created yet.
+         */
+        containerId: string | undefined;
+        /**
+         * If true, the local client should create the container and then save the created containers
+         * ID to the mapping service.
+         */
+        shouldCreate: boolean;
+        /**
+         * If `containerId` is undefined and `shouldCreate` is false, the container isn't ready
+         * but another client is creating it. In this case, the local client should wait the specified
+         * amount of time before calling `LiveShareHost.getFluidContainerId()` again.
+         */
+        retryAfter: number;
+    }
+    /**
+     * @hidden
+     * Returned from `LiveShareHost.getNtpTime()` to specify the global timestamp for the current
+     * Live Share session.
+     */
+    interface INtpTimeInfo {
+        /**
+         * ISO 8601 formatted server time. For example: '2019-09-07T15:50-04:00'
+         */
+        ntpTime: string;
+        /**
+         * Server time expressed as the number of milliseconds since the ECMAScript epoch.
+         */
+        ntpTimeInUTC: number;
+    }
+    /**
+     * @hidden
+     * Returned from `LiveShareHost.getFluidTenantInfo()` to specify the Fluid service to use for the
+     * current Live Share session.
+     */
+    interface IFluidTenantInfo {
+        /**
+         * The Fluid Tenant ID Live Share should use.
+         */
+        tenantId: string;
+        /**
+         * The Fluid service endpoint Live Share should use.
+         */
+        serviceEndpoint: string;
+    }
+    /**
+     * @hidden
+     * Returned from `LiveShareHost.getClientInfo()` to specify the client info for a
+     * particular client in a Live Share session.
+     */
+    interface IClientInfo {
+        /**
+         * The host user's `userId` associated with a given `clientId`
+         */
+        userId: string;
+        /**
+         * User's meeting roles associated with a given `clientId`
+         */
+        roles: UserMeetingRole[];
+        /**
+         * The user's display name associated with a given `clientId`.
+         * If this returns as `undefined`, the user may need to update their host client.
+         */
+        displayName?: string;
+    }
+    /**
+     * Checks if the interactive capability is supported by the host
+     * @returns boolean to represent whether the interactive capability is supported
+     *
+     * @throws Error if {@linkcode app.initialize} has not successfully completed
+     */
+    function isSupported(): boolean;
+}
+/**
+ * Live Share host implementation for connecting to real-time collaborative sessions.
+ * Designed for use with the `LiveShareClient` class in the `@microsoft/live-share` package.
+ * Learn more at https://aka.ms/teamsliveshare
+ *
+ * @remarks
+ * The `LiveShareClient` class from Live Share uses the hidden API's to join/manage the session.
+ * To create a new `LiveShareHost` instance use the static `LiveShareHost.create()` function.
+ */
+export declare class LiveShareHost {
+    /**
+     * @hidden
+     * Returns the Fluid Tenant connection info for user's current context.
+     */
+    getFluidTenantInfo(): Promise<liveShare.IFluidTenantInfo>;
+    /**
+     * @hidden
+     * Returns the fluid access token for mapped container Id.
+     *
+     * @param containerId Fluid's container Id for the request. Undefined for new containers.
+     * @returns token for connecting to Fluid's session.
+     */
+    getFluidToken(containerId?: string): Promise<string>;
+    /**
+     * @hidden
+     * Returns the ID of the fluid container associated with the user's current context.
+     */
+    getFluidContainerId(): Promise<liveShare.IFluidContainerInfo>;
+    /**
+     * @hidden
+     * Sets the ID of the fluid container associated with the current context.
+     *
+     * @remarks
+     * If this returns false, the client should delete the container they created and then call
+     * `getFluidContainerId()` to get the ID of the container being used.
+     * @param containerId ID of the fluid container the client created.
+     * @returns A data structure with a `containerState` indicating the success or failure of the request.
+     */
+    setFluidContainerId(containerId: string): Promise<liveShare.IFluidContainerInfo>;
+    /**
+     * @hidden
+     * Returns the shared clock server's current time.
+     */
+    getNtpTime(): Promise<liveShare.INtpTimeInfo>;
+    /**
+     * @hidden
+     * Associates the fluid client ID with a set of user roles.
+     *
+     * @param clientId The ID for the current user's Fluid client. Changes on reconnects.
+     * @returns The roles for the current user.
+     */
+    registerClientId(clientId: string): Promise<liveShare.UserMeetingRole[]>;
+    /**
+     * @hidden
+     * Returns the roles associated with a client ID.
+     *
+     * @param clientId The Client ID the message was received from.
+     * @returns The roles for a given client. Returns `undefined` if the client ID hasn't been registered yet.
+     */
+    getClientRoles(clientId: string): Promise<liveShare.UserMeetingRole[] | undefined>;
+    /**
+     * @hidden
+     * Returns the `IClientInfo` associated with a client ID.
+     *
+     * @param clientId The Client ID the message was received from.
+     * @returns The info for a given client. Returns `undefined` if the client ID hasn't been registered yet.
+     */
+    getClientInfo(clientId: string): Promise<liveShare.IClientInfo | undefined>;
+    /**
+     * Factories a new `LiveShareHost` instance for use with the `LiveShareClient` class
+     * in the `@microsoft/live-share` package.
+     *
+     * @remarks
+     * `app.initialize()` must first be called before using this API.
+     * This API can only be called from `meetingStage` or `sidePanel` contexts.
+     */
+    static create(): LiveShareHost;
+}

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

@@ -0,0 +1,86 @@
+import { SdkError } from './interfaces';
+/**
+ * @deprecated
+ * As of 2.1.0, please use geoLocation namespace.
+ *
+ * Namespace to interact with the location module-specific part of the SDK.
+ */
+export declare namespace location {
+    /** Get location callback function type */
+    type getLocationCallbackFunctionType = (error: SdkError, location: Location) => void;
+    /** Show location callback function type */
+    type showLocationCallbackFunctionType = (error: SdkError, status: boolean) => void;
+    /**
+     * @deprecated
+     * Data Structure to set the location properties in getLocation call.
+     */
+    interface LocationProps {
+        /**
+        whether user can alter location or not
+        if false, user will be shown current location
+        and wouldn't be allowed to alter it
+        */
+        allowChooseLocation: boolean;
+        /**
+        whether selected location should be shown to user on map or not.
+        If allowChooseLocation is true, this parameter will be ignored by platform.
+        If allowChooseLocation is false, and this parameter is not provided, default
+        value will be false.
+        */
+        showMap?: boolean;
+    }
+    /**
+     * @deprecated
+     * Data struture to represent the location information
+     */
+    interface Location {
+        /**
+        Latitude of the location
+        */
+        latitude: number;
+        /**
+        Longitude of the location
+        */
+        longitude: number;
+        /**
+        Accuracy of the coordinates captured
+        */
+        accuracy?: number;
+        /**
+        Time stamp when the location was captured
+        */
+        timestamp?: number;
+    }
+    /**
+     * @deprecated
+     * As of 2.1.0, please use one of the following functions:
+     * - {@link geoLocation.getCurrentLocation geoLocation.getCurrentLocation(): Promise\<Location\>} to get the current location.
+     * - {@link geoLocation.map.chooseLocation geoLocation.map.chooseLocation(): Promise\<Location\>} to choose location on map.
+     *
+     * Fetches user location
+     * @param props {@link LocationProps} - Specifying how the location request is handled
+     * @param callback - Callback to invoke when current user location is fetched
+     */
+    function getLocation(props: LocationProps, callback: getLocationCallbackFunctionType): void;
+    /**
+     * @deprecated
+     * As of 2.1.0, please use {@link geoLocation.map.showLocation geoLocation.map.showLocation(location: Location): Promise\<void\>} instead.
+     *
+     * Shows the location on map corresponding to the given coordinates
+     *
+     * @param location - Location to be shown on the map
+     * @param callback - Callback to invoke when the location is opened on map
+     */
+    function showLocation(location: Location, callback: showLocationCallbackFunctionType): void;
+    /**
+     * @deprecated
+     * As of 2.1.0, please use geoLocation namespace, and use {@link geoLocation.isSupported geoLocation.isSupported: boolean} to check if geoLocation is supported.
+     *
+     * Checks if Location capability is supported by the host
+     *
+     * @throws Error if {@linkcode app.initialize} has not successfully completed
+     *
+     * @returns boolean to represent whether Location is supported
+     */
+    function isSupported(): boolean;
+}

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

@@ -0,0 +1,95 @@
+/**
+ * Used to interact with mail capability, including opening and composing mail.
+ */
+export declare namespace mail {
+    /**
+     * Opens a mail message in the host.
+     *
+     * @param openMailItemParams - Object that specifies the ID of the mail message.
+     */
+    export function openMailItem(openMailItemParams: OpenMailItemParams): Promise<void>;
+    /**
+     * Compose a new email in the user's mailbox.
+     *
+     * @param composeMailParams - Object that specifies the type of mail item to compose and the details of the mail item.
+     *
+     */
+    export function composeMail(composeMailParams: ComposeMailParams): Promise<void>;
+    /**
+     * Checks if the mail capability is supported by the host
+     * @returns boolean to represent whether the mail capability is supported
+     *
+     * @throws Error if {@linkcode app.initialize} has not successfully completed
+     */
+    export function isSupported(): boolean;
+    /** Defines the parameters used to open a mail item in the user's mailbox */
+    export interface OpenMailItemParams {
+        /** An unique base64-encoded string id that represents the itemId or messageId. */
+        itemId: string;
+    }
+    /** Defines compose mail types. */
+    export enum ComposeMailType {
+        /** Compose a new mail message. */
+        New = "new",
+        /** Compose a reply to the sender of an existing mail message. */
+        Reply = "reply",
+        /** Compose a reply to all recipients of an existing mail message. */
+        ReplyAll = "replyAll",
+        /** Compose a new mail message with the content of an existing mail message forwarded to a new recipient. */
+        Forward = "forward"
+    }
+    /**
+     * Foundational interface for all other mail compose interfaces
+     * Used for holding the type of mail item being composed
+     *
+     * @typeParam T - the identity type.
+     * @see {@link mail.ComposeMailType}
+     */
+    interface ComposeMailBase<T extends ComposeMailType> {
+        /** Type of the mail item being composed. */
+        type: T;
+    }
+    /**
+     * Parameters supplied when composing a new mail item
+     */
+    export interface ComposeNewParams extends ComposeMailBase<ComposeMailType.New> {
+        /**
+         * The To: recipients for the message
+         */
+        toRecipients?: string[];
+        /**
+         * The Cc: recipients for the message
+         */
+        ccRecipients?: string[];
+        /**
+         * The Bcc: recipients for the message
+         */
+        bccRecipients?: string[];
+        /**
+         * The subject of the message
+         */
+        subject?: string;
+        /**
+         * The body of the message
+         */
+        message?: string;
+    }
+    /**
+     * Parameters supplied when composing a reply to or forward of a message
+     *
+     * @see {@link ComposeMailType}
+     */
+    export interface ComposeReplyOrForwardParams<T extends ComposeMailType> extends ComposeMailBase<T> {
+        /** An unique base64-encoded string id that represents the mail message. */
+        itemid: string;
+    }
+    /**
+     * Parameters supplied to {@link composeMail} when composing a new mail item
+     *
+     * @see {@link ComposeNewParams}
+     * @see {@link ComposeReplyOrForwardParams}
+     * @see {@link ComposeMailType}
+     */
+    export type ComposeMailParams = ComposeNewParams | ComposeReplyOrForwardParams<ComposeMailType.Reply> | ComposeReplyOrForwardParams<ComposeMailType.ReplyAll> | ComposeReplyOrForwardParams<ComposeMailType.Forward>;
+    export {};
+}