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

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

@@ -0,0 +1,66 @@
+/** onComplete function type */
+export type onCompleteFunctionType = (status: boolean, reason?: string) => void;
+/** addEventListner function type */
+export type addEventListnerFunctionType = (message: any) => void;
+/** Represents a window or frame within the host app. */
+export interface IAppWindow {
+    /**
+     * Send a message to the AppWindow.
+     *
+     * @param message - The message to send
+     * @param onComplete - The callback to know if the postMessage has been success/failed.
+     */
+    postMessage(message: any, onComplete?: onCompleteFunctionType): void;
+    /**
+     * Add a listener that will be called when an event is received from this AppWindow.
+     *
+     * @param type - The event to listen to. Currently the only supported type is 'message'.
+     * @param listener - The listener that will be called
+     */
+    addEventListener(type: string, listener: Function): void;
+}
+/**
+ * An object that application can utilize to establish communication
+ * with the child window it opened, which contains the corresponding task.
+ */
+export declare class ChildAppWindow implements IAppWindow {
+    /**
+     * Send a message to the ChildAppWindow.
+     *
+     * @param message - The message to send
+     * @param onComplete - The callback to know if the postMessage has been success/failed.
+     */
+    postMessage(message: any, onComplete?: onCompleteFunctionType): void;
+    /**
+     * Add a listener that will be called when an event is received from the ChildAppWindow.
+     *
+     * @param type - The event to listen to. Currently the only supported type is 'message'.
+     * @param listener - The listener that will be called
+     */
+    addEventListener(type: string, listener: addEventListnerFunctionType): void;
+}
+/**
+ * An object that is utilized to facilitate communication with a parent window
+ * that initiated the opening of current window. For instance, a dialog or task
+ * module would utilize it to transmit messages to the application that launched it.
+ */
+export declare class ParentAppWindow implements IAppWindow {
+    /** Represents a parent window or frame. */
+    private static _instance;
+    /** Get the parent window instance. */
+    static get Instance(): IAppWindow;
+    /**
+     * Send a message to the ParentAppWindow.
+     *
+     * @param message - The message to send
+     * @param onComplete - The callback to know if the postMessage has been success/failed.
+     */
+    postMessage(message: any, onComplete?: onCompleteFunctionType): void;
+    /**
+     * Add a listener that will be called when an event is received from the ParentAppWindow.
+     *
+     * @param type - The event to listen to. Currently the only supported type is 'message'.
+     * @param listener - The listener that will be called
+     */
+    addEventListener(type: string, listener: addEventListnerFunctionType): void;
+}

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

@@ -0,0 +1,409 @@
+/**
+ * @hidden
+ * @internal
+ * Limited to Microsoft-internal use; automatically called when library is initialized
+ */
+export declare function initialize(): void;
+/**
+ * @deprecated
+ * As of TeamsJS v2.0.0, this function has been deprecated in favor of a Promise-based pattern using {@link authentication.authenticate authentication.authenticate(authenticateParameters: AuthenticatePopUpParameters): Promise\<string\>}
+ *
+ * Registers handlers to be called with the result of an authentication flow triggered using {@link authentication.authenticate authentication.authenticate(authenticateParameters?: AuthenticateParameters): void}
+ *
+ * @param authenticateParameters - Configuration for authentication flow pop-up result communication
+ */
+export declare function registerAuthenticationHandlers(authenticateParameters: AuthenticateParameters): void;
+/**
+ * Initiates an authentication flow which requires a new window.
+ * There are two primary uses for this function:
+ * 1. When your app needs to authenticate using a 3rd-party identity provider (not Microsoft Entra ID)
+ * 2. When your app needs to show authentication UI that is blocked from being shown in an iframe (e.g., Microsoft Entra consent prompts)
+ *
+ * For more details, see [Enable authentication using third-party OAuth provider](https://learn.microsoft.com/microsoftteams/platform/tabs/how-to/authentication/auth-flow-tab)
+ *
+ * This function is *not* needed for "standard" Microsoft Entra SSO usage. Using {@link getAuthToken} is usually sufficient in that case. For more, see
+ * [Enable SSO for tab apps](https://learn.microsoft.com/microsoftteams/platform/tabs/how-to/authentication/tab-sso-overview))
+ *
+ * @remarks
+ * The authentication flow must start and end from the same domain, otherwise success and failure messages won't be returned to the window that initiated the call.
+ * The [Teams authentication flow](https://learn.microsoft.com/microsoftteams/platform/tabs/how-to/authentication/auth-flow-tab) starts and ends at an endpoint on
+ * your own service (with a redirect round-trip to the 3rd party identity provider in the middle).
+ *
+ * @param authenticateParameters - Parameters describing the authentication window used for executing the authentication flow
+ *
+ * @returns `Promise` that will be fulfilled with the result from the authentication pop-up, if successful. The string in this result is provided in the parameter
+ * passed by your app when it calls {@link authentication.notifySuccess authentication.notifySuccess(result?: string): void} in the pop-up window after returning from the identity provider redirect.
+ *
+ * @throws `Error` if the authentication request fails or is canceled by the user. This error is provided in the parameter passed by your app when it calls
+ * {@link authentication.notifyFailure authentication.notifyFailure(result?: string): void} in the pop-up window after returning from the identity provider redirect. However, in some cases it can also be provided by
+ * the infrastructure depending on the failure (e.g., a user cancelation)
+ *
+ */
+export declare function authenticate(authenticateParameters: AuthenticatePopUpParameters): Promise<string>;
+/**
+ * @deprecated
+ * As of TeamsJS v2.0.0, please use {@link authentication.authenticate authentication.authenticate(authenticateParameters: AuthenticatePopUpParameters): Promise\<string\>} instead.
+ *
+ * The documentation for {@link authentication.authenticate authentication.authenticate(authenticateParameters: AuthenticatePopUpParameters): Promise\<string\>} applies
+ * to this function.
+ * The one difference is that instead of the result being returned via the `Promise`, the result is returned to the callback functions provided in the
+ * `authenticateParameters` parameter.
+ *
+ * @param authenticateParameters - Parameters describing the authentication window used for executing the authentication flow and callbacks used for indicating the result
+ *
+ */
+export declare function authenticate(authenticateParameters?: AuthenticateParameters): void;
+/**
+ * Requests an Microsoft Entra token to be issued on behalf of your app in an SSO flow.
+ * The token is acquired from the cache if it is not expired. Otherwise a request is sent to Microsoft Entra to
+ * obtain a new token.
+ * This function is used to enable SSO scenarios. See [Enable SSO for tab apps](https://learn.microsoft.com/microsoftteams/platform/tabs/how-to/authentication/tab-sso-overview)
+ * for more details.
+ *
+ * @param authTokenRequest - An optional set of values that configure the token request.
+ *
+ * @returns `Promise` that will be resolved with the token, if successful.
+ *
+ * @throws `Error` if the request fails in some way
+ */
+export declare function getAuthToken(authTokenRequest?: AuthTokenRequestParameters): Promise<string>;
+/**
+ * @deprecated
+ * As of TeamsJS v2.0.0, please use {@link authentication.getAuthToken authentication.getAuthToken(authTokenRequest: AuthTokenRequestParameters): Promise\<string\>} instead.
+ *
+ * The documentation {@link authentication.getAuthToken authentication.getAuthToken(authTokenRequest: AuthTokenRequestParameters): Promise\<string\>} applies to this
+ * function as well. The one difference when using this function is that the result is provided in the callbacks in the `authTokenRequest` parameter
+ * instead of as a `Promise`.
+ *
+ * @param authTokenRequest - An optional set of values that configure the token request.
+ * It contains callbacks to call in case of success/failure
+ */
+export declare function getAuthToken(authTokenRequest?: AuthTokenRequest): void;
+/**
+ * @hidden
+ * Requests the decoded Microsoft Entra user identity on behalf of the app.
+ *
+ * @returns Promise that resolves with the {@link UserProfile}.
+ *
+ * @throws `Error` object in case of any problems, the most likely of which is that the calling app does not have appropriate permissions
+ * to call this method.
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare function getUser(): Promise<UserProfile>;
+/**
+ * @deprecated
+ * As of TeamsJS v2.0.0, please use {@link authentication.getUser authentication.getUser(): Promise\<UserProfile\>} instead.
+ *
+ * @hidden
+ * Requests the decoded Microsoft Entra user identity on behalf of the app.
+ *
+ * @param userRequest - It passes success/failure callbacks in the userRequest object(deprecated)
+ *
+ * @throws `Error` object in case of any problems, the most likely of which is that the calling app does not have appropriate permissions
+ * to call this method.
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare function getUser(userRequest: UserRequest): void;
+/**
+ * When using {@link authentication.authenticate authentication.authenticate(authenticateParameters: AuthenticatePopUpParameters): Promise\<string\>}, the
+ * window that was opened to execute the authentication flow should call this method after authentiction to notify the caller of
+ * {@link authentication.authenticate authentication.authenticate(authenticateParameters: AuthenticatePopUpParameters): Promise\<string\>} that the
+ * authentication request was successful.
+ *
+ * @remarks
+ * This function is usable only from the authentication window.
+ * This call causes the authentication window to be closed.
+ *
+ * @param result - Specifies a result for the authentication. If specified, the frame that initiated the authentication pop-up receives
+ * this value in its callback or via the `Promise` return value
+ */
+export declare function notifySuccess(result?: string): void;
+/**
+   * When using {@link authentication.authenticate authentication.authenticate(authenticateParameters: AuthenticatePopUpParameters): Promise\<string\>}, the
+   * window that was opened to execute the authentication flow should call this method after authentiction to notify the caller of
+   * {@link authentication.authenticate authentication.authenticate(authenticateParameters: AuthenticatePopUpParameters): Promise\<string\>} that the
+   * authentication request failed.
+
+   *
+   * @remarks
+   * This function is usable only on the authentication window.
+   * This call causes the authentication window to be closed.
+   *
+   * @param result - Specifies a result for the authentication. If specified, the frame that initiated the authentication pop-up receives
+   * this value in its callback or via the `Promise` return value
+   * @param _callbackUrl - This parameter is deprecated and unused
+   */
+export declare function notifyFailure(result?: string): void;
+/**
+ * @deprecated
+ * As of TeamsJS v2.0.0, this interface has been deprecated in favor of leveraging the `Promise` returned from {@link authentication.authenticate authentication.authenticate(authenticateParameters: AuthenticatePopUpParameters): Promise\<string\>}
+ *-------------------------
+ * Used in {@link AuthenticateParameters} and {@link AuthTokenRequest}
+ */
+export interface LegacyCallBacks {
+    /**
+     * @deprecated
+     * As of TeamsJS v2.0.0, this property has been deprecated in favor of a Promise-based pattern.
+     *
+     * A function that is called if the request succeeds.
+     */
+    successCallback?: (result: string) => void;
+    /**
+     * @deprecated
+     * As of TeamsJS v2.0.0, this property has been deprecated in favor of a Promise-based pattern.
+     *
+     * A function that is called if the request fails, with the reason for the failure.
+     */
+    failureCallback?: (reason: string) => void;
+}
+/**
+ * Describes the authentication pop-up parameters
+ */
+export interface AuthenticatePopUpParameters {
+    /**
+     * The URL for the authentication pop-up.
+     */
+    url: string;
+    /**
+     * The preferred width for the pop-up. This value can be ignored if outside the acceptable bounds.
+     */
+    width?: number;
+    /**
+     * The preferred height for the pop-up. This value can be ignored if outside the acceptable bounds.
+     */
+    height?: number;
+    /**
+     * Some identity providers restrict their authentication pages from being displayed in embedded browsers (e.g., a web view inside of a native application)
+     * If the identity provider you are using prevents embedded browser usage, this flag should be set to `true` to enable the authentication page specified in
+     * the {@link url} property to be opened in an external browser.
+     * If this flag is `false`, the page will be opened directly within the current hosting application.
+     *
+     * This flag is ignored when the host for the application is a web app (as opposed to a native application) as the behavior is unnecessary in a web-only
+     * environment without an embedded browser.
+     */
+    isExternal?: boolean;
+}
+/**
+ * @deprecated
+ * As of TeamsJS v2.0.0, please use {@link authentication.authenticate authentication.authenticate(authenticateParameters: AuthenticatePopUpParameters): Promise\<string\>} and
+ * the associated {@link AuthenticatePopUpParameters} instead.
+ *
+ * @see {@link LegacyCallBacks}
+ */
+export type AuthenticateParameters = AuthenticatePopUpParameters & LegacyCallBacks;
+/**
+ * Describes authentication token request parameters
+ */
+export interface AuthTokenRequestParameters {
+    /**
+     * @hidden
+     * @internal
+     * An list of resources for which to acquire the access token; only for internal Microsoft usage
+     */
+    resources?: string[];
+    /**
+     * An optional list of claims which to pass to Microsoft Entra when requesting the access token.
+     */
+    claims?: string[];
+    /**
+     * An optional flag indicating whether to attempt the token acquisition silently or allow a prompt to be shown.
+     */
+    silent?: boolean;
+    /**
+     * An optional identifier of the home tenant for which to acquire the access token for (used in cross-tenant shared channels).
+     */
+    tenantId?: string;
+}
+/**
+ * @deprecated
+ * As of TeamsJS v2.0.0, please use {@link AuthTokenRequestParameters} instead.
+ */
+export type AuthTokenRequest = AuthTokenRequestParameters & LegacyCallBacks;
+/**
+ * @hidden
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export interface UserProfile {
+    /**
+     * @hidden
+     * The intended recipient of the token. The application that receives the token must verify that the audience
+     * value is correct and reject any tokens intended for a different audience.
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    aud: string;
+    /**
+     * @hidden
+     * Identifies how the subject of the token was authenticated.
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    amr: string[];
+    /**
+     * @hidden
+     * Stores the time at which the token was issued. It is often used to measure token freshness.
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    iat: number;
+    /**
+     * @hidden
+     * Identifies the security token service (STS) that constructs and returns the token. In the tokens that Microsoft Entra
+     * returns, the issuer is sts.windows.net. The GUID in the issuer claim value is the tenant ID of the Microsoft Entra
+     * directory. The tenant ID is an immutable and reliable identifier of the directory.
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    iss: string;
+    /**
+     * @hidden
+     * Provides the last name, surname, or family name of the user as defined in the Microsoft Entra user object.
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    family_name: string;
+    /**
+     * @hidden
+     * Provides the first or "given" name of the user, as set on the Microsoft Entra user object.
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    given_name: string;
+    /**
+     * @hidden
+     * Provides a human-readable value that identifies the subject of the token. This value is not guaranteed to
+     * be unique within a tenant and is designed to be used only for display purposes.
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    unique_name: string;
+    /**
+     * @hidden
+     * Contains a unique identifier of an object in Microsoft Entra. This value is immutable and cannot be reassigned or
+     * reused. Use the object ID to identify an object in queries to Microsoft Entra.
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    oid: string;
+    /**
+     * @hidden
+     * Identifies the principal about which the token asserts information, such as the user of an application.
+     * This value is immutable and cannot be reassigned or reused, so it can be used to perform authorization
+     * checks safely. Because the subject is always present in the tokens the Microsoft Entra issues, we recommended
+     * using this value in a general-purpose authorization system.
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    sub: string;
+    /**
+     * @hidden
+     * An immutable, non-reusable identifier that identifies the directory tenant that issued the token. You can
+     * use this value to access tenant-specific directory resources in a multitenant application. For example,
+     * you can use this value to identify the tenant in a call to the Graph API.
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    tid: string;
+    /**
+     * @hidden
+     * Defines the end of the time interval within which a token is valid. The service that validates the token
+     * should verify that the current date is within the token lifetime; otherwise it should reject the token. The
+     * service might allow for up to five minutes beyond the token lifetime to account for any differences in clock
+     * time ("time skew") between Microsoft Entra and the service.
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    exp: number;
+    /**
+     * @hidden
+     * Defines the start of the time interval within which a token is valid. The service that validates the token
+     * should verify that the current date is within the token lifetime; otherwise it should reject the token. The
+     * service might allow for up to five minutes beyond the token lifetime to account for any differences in clock
+     * time ("time skew") between Microsoft Entra and the service.
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    nbf: number;
+    /**
+     * @hidden
+     * Stores the user name of the user principal.
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    upn: string;
+    /**
+     * @hidden
+     * Stores the version number of the token.
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    ver: string;
+    /**
+     * @hidden
+     * Stores the data residency of the user.
+     *
+     * @internal
+     * Limited to Microsoft-internal use
+     */
+    dataResidency?: DataResidency;
+}
+/**
+ * @hidden
+ * Limited set of data residencies information exposed to 1P application developers
+ *
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export declare enum DataResidency {
+    /**
+     * Public
+     */
+    Public = "public",
+    /**
+     * European Union Data Boundary
+     */
+    EUDB = "eudb",
+    /**
+     * Other, stored to cover fields that will not be exposed
+     */
+    Other = "other"
+}
+/**
+ * @deprecated
+ * As of TeamsJS v2.0.0, this interface has been deprecated in favor of a Promise-based pattern.
+ * @hidden
+ * Describes the UserRequest. Success callback describes how a successful request is handled.
+ * Failure callback describes how a failed request is handled.
+ * @internal
+ * Limited to Microsoft-internal use
+ */
+export interface UserRequest {
+    /**
+     * A function that is called if the token request succeeds, with the resulting token.
+     */
+    successCallback?: (user: UserProfile) => void;
+    /**
+     * A function that is called if the token request fails, with the reason for the failure.
+     */
+    failureCallback?: (reason: string) => void;
+}

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

@@ -0,0 +1,53 @@
+/**
+ * Namespace to interact with the barcode scanning-specific part of the SDK.
+ *
+ * @beta
+ */
+/**
+ * Data structure to customize the barcode scanning experience in scanBarCode API.
+ * All properties in BarCodeConfig are optional and have default values in the platform
+ *
+ * @beta
+ */
+export interface BarCodeConfig {
+    /**
+     * Optional; designates the scan timeout interval in seconds.
+     * Default value is 30 seconds, max allowed value is 60 seconds.
+     */
+    timeOutIntervalInSec?: number;
+}
+/**
+ * Scan Barcode or QRcode using camera
+ *
+ * @param barCodeConfig - input configuration to customize the barcode scanning experience
+ *
+ * @returns a scanned code
+ *
+ * @beta
+ */
+export declare function scanBarCode(barCodeConfig: BarCodeConfig): Promise<string>;
+/**
+ * Checks whether or not media has user permission
+ *
+ * @returns true if the user has granted the app permission to media information, false otherwise
+ *
+ * @beta
+ */
+export declare function hasPermission(): Promise<boolean>;
+/**
+ * Requests user permission for media
+ *
+ * @returns true if the user has granted the app permission to the media, false otherwise
+ *
+ * @beta
+ */
+export declare function requestPermission(): Promise<boolean>;
+/**
+ * Checks if barCode capability is supported by the host
+ * @returns boolean to represent whether the barCode capability is supported
+ *
+ * @throws Error if {@linkcode app.initialize} has not successfully completed
+ *
+ * @beta
+ */
+export declare function isSupported(): boolean;

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

@@ -0,0 +1,40 @@
+/**
+ * Interact with the user's calendar, including opening calendar items and composing meetings.
+ */
+/**
+ * Opens a calendar item.
+ *
+ * @param openCalendarItemParams - object containing unique ID of the calendar item to be opened.
+ */
+export declare function openCalendarItem(openCalendarItemParams: OpenCalendarItemParams): Promise<void>;
+/**
+ * Compose a new meeting in the user's calendar.
+ *
+ * @param composeMeetingParams - object containing various properties to set up the meeting details.
+ */
+export declare function composeMeeting(composeMeetingParams: ComposeMeetingParams): Promise<void>;
+/**
+ * Checks if the calendar capability is supported by the host
+ * @returns boolean to represent whether the calendar capability is supported
+ *
+ * @throws Error if {@linkcode app.initialize} has not successfully completed
+ */
+export declare function isSupported(): boolean;
+/** Open calendar item parameters. */
+export interface OpenCalendarItemParams {
+    /** An unique base64-encoded string id that represents the event's unique identifier of the calendar item to be opened. */
+    itemId: string;
+}
+/** Compose meeting parameters */
+export interface ComposeMeetingParams {
+    /** An array of email addresses, user name, or user id of the attendees to invite to the meeting. */
+    attendees?: string[];
+    /** The start time of the meeting in MM/DD/YYYY HH:MM:SS format. */
+    startTime?: string;
+    /** The end time of the meeting in MM/DD/YYYY HH:MM:SS format. */
+    endTime?: string;
+    /** The subject line of the meeting. */
+    subject?: string;
+    /** The body content of the meeting. */
+    content?: string;
+}

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

@@ -0,0 +1,53 @@
+/**
+ * Used to interact with call functionality, including starting calls with other users.
+ */
+/** Modalities that can be associated with a call. */
+export declare enum CallModalities {
+    /** Indicates that the modality is unknown or undefined. */
+    Unknown = "unknown",
+    /** Indicates that the call includes audio. */
+    Audio = "audio",
+    /** Indicates that the call includes video. */
+    Video = "video",
+    /** Indicates that the call includes video-based screen sharing. */
+    VideoBasedScreenSharing = "videoBasedScreenSharing",
+    /** Indicates that the call includes data sharing or messaging. */
+    Data = "data"
+}
+/** Represents parameters for {@link startCall | StartCall}. */
+export interface StartCallParams {
+    /**
+     * Comma-separated list of user IDs representing the participants of the call.
+     *
+     * @remarks
+     * Currently the User ID field supports the Microsoft Entra UserPrincipalName,
+     * typically an email address, or in case of a PSTN call, it supports a pstn
+     * mri 4:\<phonenumber>.
+     */
+    targets: string[];
+    /**
+     * List of modalities for the call. Defaults to [“audio”].
+     */
+    requestedModalities?: CallModalities[];
+    /**
+     * An optional parameter that informs about the source of the deep link
+     */
+    source?: string;
+}
+/**
+ * Starts a call with other users
+ *
+ * @param startCallParams - Parameters for the call
+ *
+ * @throws Error if call capability is not supported
+ * @throws Error if host notifies of a failed start call attempt in a legacy Teams environment
+ * @returns always true if the host notifies of a successful call inititation
+ */
+export declare function startCall(startCallParams: StartCallParams): Promise<boolean>;
+/**
+ * Checks if the call capability is supported by the host
+ * @returns boolean to represent whether the call capability is supported
+ *
+ * @throws Error if {@linkcode app.initialize} has not successfully completed
+ */
+export declare function isSupported(): boolean;

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

@@ -0,0 +1,66 @@
+interface OpenChatRequest {
+    /**
+     * An optional message used when initiating chat
+     */
+    message?: string;
+}
+/**
+ * Used when starting a chat with one person
+ *
+ * @see OpenGroupChatRequest for use when a chat with more than one person
+ */
+export interface OpenSingleChatRequest extends OpenChatRequest {
+    /**
+     * The [Microsoft Entra UPN](https://learn.microsoft.com/entra/identity/hybrid/connect/plan-connect-userprincipalname) (usually but not always an e-mail address)
+     * of the user with whom to begin a chat
+     */
+    user: string;
+}
+/**
+ * Used when starting a chat with more than one person
+ *
+ * @see OpenSingleChatRequest for use in a chat with only one person
+ */
+export interface OpenGroupChatRequest extends OpenChatRequest {
+    /**
+     * Array containing [Microsoft Entra UPNs](https://learn.microsoft.com/entra/identity/hybrid/connect/plan-connect-userprincipalname) (usually but not always an e-mail address)
+     * of users with whom to begin a chat
+     */
+    users: string[];
+    /**
+     * The display name of a conversation for 3 or more users (chats with fewer than three users will ignore this field)
+     */
+    topic?: string;
+}
+/**
+ * Contains functionality to start chat with others
+ */
+export declare namespace chat {
+    /**
+     * Allows the user to open a chat with a single user and allows
+     * for the user to specify the message they wish to send.
+     *
+     * @param openChatRequest: {@link OpenSingleChatRequest}- a request object that contains a user's email as well as an optional message parameter.
+     *
+     * @returns Promise resolved upon completion
+     */
+    function openChat(openChatRequest: OpenSingleChatRequest): Promise<void>;
+    /**
+     * Allows the user to create a chat with multiple users (2+) and allows
+     * for the user to specify a message and name the topic of the conversation. If
+     * only 1 user is provided into users array default back to origin openChat.
+     *
+     * @param openChatRequest: {@link OpenGroupChatRequest} - a request object that contains a list of user emails as well as optional parameters for message and topic (display name for the group chat).
+     *
+     * @returns Promise resolved upon completion
+     */
+    function openGroupChat(openChatRequest: OpenGroupChatRequest): Promise<void>;
+    /**
+     * Checks if the chat capability is supported by the host
+     * @returns boolean to represent whether the chat capability is supported
+     *
+     * @throws Error if {@linkcode app.initialize} has not successfully completed
+     */
+    function isSupported(): boolean;
+}
+export {};