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

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

@@ -0,0 +1,1133 @@
+import { ChannelType, DialogDimension, HostClientType, HostName, TeamType, UserTeamRole } from './constants';
+import { FrameContexts } from './constants';
+/**
+ * Represents information about tabs for an app
+ */
+export interface TabInformation {
+    /** Represents the tabs associated with a Microsoft Teams app */
+    teamTabs: TabInstance[];
+}
+/**
+ * Represents information about a tab instance
+ */
+export interface TabInstance {
+    /**
+     * The name of the tab
+     */
+    tabName: string;
+    /**
+     * @internal
+     * Limited to Microsoft-internal use
+     * @protected
+     */
+    internalTabInstanceId?: string;
+    /**
+     * Last viewed time of this tab. null means unknown
+     */
+    lastViewUnixEpochTime?: string;
+    /**
+     * The developer-defined unique ID for the entity this content points to.
+     */
+    entityId?: string;
+    /**
+     * The Microsoft Teams ID for the channel with which the content is associated.
+     */
+    channelId?: string;
+    /**
+     * The name for the channel with which the content is associated.
+     */
+    channelName?: string;
+    /**
+     * Is this tab in a favorite channel?
+     */
+    channelIsFavorite?: boolean;
+    /**
+     * The Microsoft Teams ID for the team with which the content is associated.
+     */
+    teamId?: string;
+    /**
+     * The name for the team with which the content is associated.
+     */
+    teamName?: string;
+    /**
+     * Is this tab in a favorite team?
+     */
+    teamIsFavorite?: boolean;
+    /**
+     * The Office 365 group ID for the team with which the content is associated.
+     * This field is available only when the identity permission is requested in the manifest.
+     */
+    groupId?: string;
+    /**
+     * Content URL of this tab
+     */
+    url?: string;
+    /**
+     * Website URL of this tab
+     */
+    websiteUrl?: string;
+    /**
+     * AppId of this tab
+     */
+    appId?: string;
+    /**
+     * Order of this tab. Order is 1-indexed.
+     */
+    order?: number;
+}
+/**
+ * Indicates information about the tab instance for filtering purposes.
+ */
+export interface TabInstanceParameters {
+    /**
+     * Flag allowing to select favorite channels only
+     */
+    favoriteChannelsOnly?: boolean;
+    /**
+     * Flag allowing to select favorite teams only
+     */
+    favoriteTeamsOnly?: boolean;
+}
+/**
+ * Represents Team Information
+ */
+export interface TeamInformation {
+    /**
+     * Id of the team
+     */
+    teamId: string;
+    /**
+     * Team display name
+     */
+    teamName: string;
+    /**
+     * Team description
+     */
+    teamDescription?: string;
+    /**
+     * Thumbnail Uri
+     */
+    thumbnailUri?: string;
+    /**
+     * The Office 365 group ID for the team with which the content is associated.
+     * This field is available only when the identity permission is requested in the manifest.
+     */
+    groupId?: string;
+    /**
+     * Role of current user in the team
+     */
+    userTeamRole?: UserTeamRole;
+    /**
+     * The type of the team.
+     */
+    teamType?: TeamType;
+    /**
+     * The locked status of the team
+     */
+    isTeamLocked?: boolean;
+    /**
+     * The archived status of the team
+     */
+    isTeamArchived?: boolean;
+}
+/**
+ * Represents OS locale info used for formatting date and time data
+ */
+export interface LocaleInfo {
+    /** Represents the user's platform on which the app is running. */
+    platform: HostClientType.android | HostClientType.ios | HostClientType.macos | 'windows';
+    /**
+     * Represents the regional format used by the user's locale.
+     * @example `en-us`.
+     */
+    regionalFormat: string;
+    /**
+     * Displays date values, as specified by the short date format MM/DD/YYYY in user's regional settings.
+     * @example 4/21/2023 or 4-21-2023
+     */
+    shortDate: string;
+    /**
+     * Displays only date values, as specified by the Long Date format in user's regional settings.
+     * @example Friday, April 21, 2023
+     */
+    longDate: string;
+    /**
+     * A string representing the short time format used by the user's locale.
+     * @example 10:10
+     */
+    shortTime: string;
+    /**
+     * A string representing the long time format used by the user's locale.
+     * @example 10:10:42 AM
+     */
+    longTime: string;
+}
+/**
+ * Allowed user file open preferences
+ */
+export declare enum FileOpenPreference {
+    /** Indicates that the user should be prompted to open the file in inline. */
+    Inline = "inline",
+    /** Indicates that the user should be prompted to open the file in the native desktop application associated with the file type. */
+    Desktop = "desktop",
+    /** Indicates that the user should be prompted to open the file in a web browser. */
+    Web = "web"
+}
+/**
+ * Types of Action Objects
+ *
+ * @beta
+ */
+export declare enum ActionObjectType {
+    /** Represents content within a Microsoft 365 application. */
+    M365Content = "m365content"
+}
+/**
+ * Data pertaining to object(s) the action is being performed on
+ *
+ * @param T The type of action being implemented
+ *
+ * @beta
+ */
+export interface BaseActionObject<T extends ActionObjectType> {
+    /** Represents action type. */
+    type: T;
+}
+/**
+ * Stores information needed to represent content stored in OneDrive or Sharepoint
+ *
+ * @beta
+ */
+export interface M365ContentAction extends BaseActionObject<ActionObjectType.M365Content> {
+    /**
+     * Only office content IDs are passed to the app. Apps should use these ids
+     * to query the Microsoft graph for more details.
+     */
+    itemId: string;
+    /** Represents an optional secondary identifier for an action in a Microsoft 365 content item. */
+    secondaryId?: SecondaryId;
+}
+/**
+ * Contains additional IDs of the content that the action is triggered from. Maps to ids used in the Graph.
+ *
+ * @beta
+ */
+export interface SecondaryId {
+    /** Name of the secondary id that should be used. */
+    name: SecondaryM365ContentIdName;
+    /** The secondary id value that can be used to retrieve M365 content. */
+    value: string;
+}
+/**
+ * These correspond with field names in the MSGraph.
+ * See [commonly accessed resources](https://learn.microsoft.com/graph/api/resources/onedrive?view=graph-rest-1.0#commonly-accessed-resources).
+ * @beta
+ */
+export declare enum SecondaryM365ContentIdName {
+    /** OneDrive ID */
+    DriveId = "driveId",
+    /** Teams Group ID */
+    GroupId = "groupId",
+    /** SharePoint ID */
+    SiteId = "siteId",
+    /** User ID */
+    UserId = "userId"
+}
+/**
+ * Information about an Action.
+ *
+ * @remarks
+ * This contains Id of the action, and the information about the object that triggered the action.
+ * @beta
+ */
+export interface ActionInfo {
+    /**
+     * Id of the action. Maps to the action id supplied inside the manifest
+     */
+    actionId: string;
+    /**
+     * Array of corresponding action objects
+     */
+    actionObjects: BaseActionObject<ActionObjectType>[];
+}
+/**
+ * @deprecated
+ * As of TeamsJS v2.0.0, please use the {@link app.Context} interface and its updated properties instead.
+ *
+ * @remarks
+ * For more details about the updated {@link app.Context} interface, visit the
+ * [Teams JavaScript client SDK](https://learn.microsoft.com/microsoftteams/platform/tabs/how-to/using-teams-client-sdk#updates-to-the-context-interface)
+ * overview article.
+ *
+ * Represents the structure of the received context message.
+ */
+export interface Context {
+    /**
+     * @deprecated
+     * As of TeamsJS v2.0.0, please use {@link ActionInfo | app.Context.actionInfo} instead
+     *
+     * Common information applicable to all content actions
+     */
+    actionInfo?: ActionInfo;
+    /**
+     * @deprecated
+     * As of TeamsJS v2.0.0, please use {@link app.TeamInfo.groupId | app.Context.team.groupId} instead
+     *
+     * The Office 365 group ID for the team with which the content is associated.
+     * This field is available only when the identity permission is requested in the manifest.
+     */
+    groupId?: string;
+    /**
+     * @deprecated
+     * As of TeamsJS v2.0.0, please use {@link app.TeamInfo.internalId | app.Context.team.internalId} instead
+     *
+     * The Microsoft Teams ID for the team with which the content is associated.
+     */
+    teamId?: string;
+    /**
+     * @deprecated
+     * As of TeamsJS v2.0.0, please use {@link app.TeamInfo.displayName | app.Context.team.displayName} instead
+     *
+     * The name for the team with which the content is associated.
+     */
+    teamName?: string;
+    /**
+     * @deprecated
+     * As of TeamsJS v2.0.0, please use {@link app.ChannelInfo.id | app.Context.channel.id} instead
+     *
+     * The Microsoft Teams ID for the channel with which the content is associated.
+     */
+    channelId?: string;
+    /**
+     * @deprecated
+     * As of TeamsJS v2.0.0, please use {@link app.ChannelInfo.displayName | app.Context.channel.displayName} instead
+     *
+     * The name for the channel with which the content is associated.
+     */
+    channelName?: string;
+    /**
+     * @deprecated
+     * As of TeamsJS v2.0.0, please use {@link app.ChannelInfo.membershipType | app.Context.channel.membershipType} instead
+     *
+     * The type of the channel with which the content is associated.
+     */
+    channelType?: ChannelType;
+    /**
+     * @deprecated
+     * As of TeamsJS v2.0.0, please use {@link app.PageInfo.id | app.Context.page.id} instead
+     *
+     * The developer-defined unique ID for the entity this content points to.
+     */
+    entityId: string;
+    /**
+     * @deprecated
+     * As of TeamsJS v2.0.0, please use {@link app.PageInfo.subPageId | app.Context.page.subPageId} instead
+     *
+     * The developer-defined unique ID for the sub-entity this content points to.
+     * 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.
+     */
+    subEntityId?: string;
+    /**
+     * @deprecated
+     * As of TeamsJS v2.0.0, please use {@link app.AppInfo.locale | app.Context.app.locale} instead
+     *
+     * The current locale that the user has configured for the app formatted as
+     * languageId-countryId (for example, en-us).
+     */
+    locale: string;
+    /**
+     * @deprecated
+     * As of TeamsJS v2.0.0, please use {@link app.AppInfo.osLocaleInfo | app.Context.app.osLocaleInfo} instead
+     *
+     * More detailed locale info from the user's OS if available. Can be used together with
+     * the @microsoft/globe NPM package to ensure your app respects the user's OS date and
+     * time format configuration
+     */
+    osLocaleInfo?: LocaleInfo;
+    /**
+     * @deprecated
+     *
+     * As of TeamsJS v2.0.0, please use {@link app.UserInfo.loginHint | app.Context.user.loginHint} or
+     * {@link app.UserInfo.userPrincipalName | app.Context.user.userPrincipalName} instead.
+     * The UPN of the current user.
+     * Because a malicious party can run your content in a browser, this value should
+     * be used only as a hint as to who the user is and never as proof of identity.
+     * This field is available only when the identity permission is requested in the manifest.
+     */
+    upn?: string;
+    /**
+     * @deprecated
+     * As of TeamsJS v2.0.0, please use {@link app.TenantInfo.id | app.Context.user.tenant.id} instead
+     *
+     * The Microsoft Entra tenant ID of the current user.
+     * Because a malicious party can run your content in a browser, this value should
+     * be used only as a hint as to who the user is and never as proof of identity.
+     * This field is available only when the identity permission is requested in the manifest.
+     */
+    tid?: string;
+    /**
+     * @deprecated
+     * As of TeamsJS v2.0.0, please use {@link app.AppInfo.theme | app.Context.app.theme} instead
+     *
+     * The current UI theme.
+     */
+    theme?: string;
+    /**
+     * @deprecated
+     * As of TeamsJS v2.0.0, please use {@link app.PageInfo.isFullScreen | app.Context.page.isFullScreen} instead
+     *
+     * Indication whether the tab is in full-screen mode.
+     */
+    isFullScreen?: boolean;
+    /**
+     * @deprecated
+     * As of TeamsJS v2.0.0, please use {@link app.TeamInfo.type | app.Context.team.type} instead
+     *
+     * The type of the team.
+     */
+    teamType?: TeamType;
+    /**
+     * @deprecated
+     * As of TeamsJS v2.0.0, please use {@link app.SharePointSiteInfo.teamSiteUrl | app.Context.sharePointSite.teamSiteUrl} instead
+     *
+     * The root SharePoint site associated with the team.
+     */
+    teamSiteUrl?: string;
+    /**
+     * @deprecated
+     * As of TeamsJS v2.0.0, please use {@link app.SharePointSiteInfo.teamSiteDomain | app.Context.sharePointSite.teamSiteDomain} instead
+     *
+     * The domain of the root SharePoint site associated with the team.
+     */
+    teamSiteDomain?: string;
+    /**
+     * @deprecated
+     * As of TeamsJS v2.0.0, please use {@link app.SharePointSiteInfo.teamSitePath | app.Context.sharePointSite.teamSitePath} instead
+     *
+     * The relative path to the SharePoint site associated with the team.
+     */
+    teamSitePath?: string;
+    /**
+     * @deprecated
+     * As of TeamsJS v2.0.0, please use {@link app.ChannelInfo.ownerTenantId | app.Context.channel.ownerTenantId} instead
+     *
+     * The tenant ID of the host team.
+     */
+    hostTeamTenantId?: string;
+    /**
+     * @deprecated
+     * As of TeamsJS v2.0.0, please use {@link app.ChannelInfo.ownerGroupId | app.Context.channel.ownerGroupId} instead
+     *
+     * The Microsoft Entra group ID of the host team.
+     */
+    hostTeamGroupId?: string;
+    /**
+     * @deprecated
+     * As of TeamsJS v2.0.0, please use {@link app.ChannelInfo.relativeUrl | app.Context.channel.relativeUrl} instead
+     *
+     * The relative path to the SharePoint folder associated with the channel.
+     */
+    channelRelativeUrl?: string;
+    /**
+     * @deprecated
+     * As of TeamsJS v2.0.0, please use {@link app.AppHostInfo.sessionId | app.Context.app.host.sessionId} instead
+     *
+     * Unique ID for the current Teams session for use in correlating telemetry data.
+     */
+    sessionId?: string;
+    /**
+     * @deprecated
+     * As of TeamsJS v2.0.0, please use {@link app.TeamInfo.userRole | app.Context.team.userRole} instead
+     *
+     * The user's role in the team.
+     * Because a malicious party can run your content in a browser, this value should
+     * be used only as a hint as to the user's role, and never as proof of her role.
+     */
+    userTeamRole?: UserTeamRole;
+    /**
+     * @deprecated
+     * As of TeamsJS v2.0.0, please use {@link app.ChatInfo.id | app.Context.chat.id} instead
+     *
+     * The Microsoft Teams ID for the chat with which the content is associated.
+     */
+    chatId?: string;
+    /**
+     * @deprecated
+     * As of TeamsJS v2.0.0, please use {@link app.UserInfo.loginHint | app.Context.user.loginHint} instead
+     *
+     * A value suitable for use as a login_hint when authenticating with Microsoft Entra ID.
+     * Because a malicious party can run your content in a browser, this value should
+     * be used only as a hint as to who the user is and never as proof of identity.
+     * This field is available only when the identity permission is requested in the manifest.
+     */
+    loginHint?: string;
+    /**
+     * @deprecated
+     * As of TeamsJS v2.0.0, please use {@link app.UserInfo.userPrincipalName | app.Context.user.userPrincipalName} instead
+     *
+     * The UPN of the current user. This may be an externally-authenticated UPN (e.g., guest users).
+     * Because a malicious party run your content in a browser, this value should
+     * be used only as a hint as to who the user is and never as proof of identity.
+     * This field is available only when the identity permission is requested in the manifest.
+     */
+    userPrincipalName?: string;
+    /**
+     * @deprecated
+     * As of TeamsJS v2.0.0, please use {@link app.UserInfo.id | app.Context.user.id} instead
+     *
+     * The Microsoft Entra object ID of the current user.
+     * Because a malicious party run your content in a browser, this value should
+     * be used only as a hint as to who the user is and never as proof of identity.
+     * This field is available only when the identity permission is requested in the manifest.
+     */
+    userObjectId?: string;
+    /**
+     * @deprecated
+     * As of TeamsJS v2.0.0, please use {@link app.TeamInfo.isArchived | app.Context.team.isArchived} instead
+     *
+     * Indicates whether team is archived.
+     * Apps should use this as a signal to prevent any changes to content associated with archived teams.
+     */
+    isTeamArchived?: boolean;
+    /**
+     * @deprecated
+     * As of TeamsJS v2.0.0, please use {@link app.AppHostInfo.name | app.Context.app.host.name} instead
+     *
+     * The name of the host client. Possible values are: Office, Orange, Outlook, Teams
+     */
+    hostName?: HostName;
+    /**
+     * @deprecated
+     * As of TeamsJS v2.0.0, please use {@link app.AppHostInfo.clientType | app.Context.app.host.clientType} instead
+     *
+     * The type of the host client. Possible values are : android, ios, web, desktop, rigel(deprecated, use teamsRoomsWindows instead),
+     * surfaceHub, teamsRoomsWindows, teamsRoomsAndroid, teamsPhones, teamsDisplays
+     */
+    hostClientType?: HostClientType;
+    /**
+     * @deprecated
+     * As of TeamsJS v2.0.0, please use {@link app.PageInfo.frameContext | app.Context.page.frameContext} instead
+     *
+     * The context where tab url is loaded (content, task, setting, remove, sidePanel)
+     */
+    frameContext?: FrameContexts;
+    /**
+     * @deprecated
+     * As of TeamsJS v2.0.0, please use {@link app.Context | app.Context.sharepoint} instead
+     *
+     * SharePoint context. This is only available when hosted in SharePoint.
+     */
+    sharepoint?: any;
+    /**
+     * @deprecated
+     * As of TeamsJS v2.0.0, please use {@link app.TenantInfo.teamsSku | app.Context.tenant.teamsSku} instead
+     *
+     * The type of license for the current users tenant.
+     */
+    tenantSKU?: string;
+    /**
+     * @deprecated
+     * As of TeamsJS v2.0.0, please use {@link app.UserInfo.licenseType | app.Context.user.licenseType} instead
+     *
+     * The license type for the current user.
+     */
+    userLicenseType?: string;
+    /**
+     * @deprecated
+     * As of TeamsJS v2.0.0, please use {@link app.AppInfo.parentMessageId | app.Context.app.parentMessageId} instead
+     *
+     * The ID of the parent message from which this task module was launched.
+     * This is only available in task modules launched from bot cards.
+     */
+    parentMessageId?: string;
+    /**
+     * @deprecated
+     * As of TeamsJS v2.0.0, please use {@link app.AppHostInfo.ringId | app.Context.app.host.ringId} instead
+     *
+     * Current ring ID
+     */
+    ringId?: string;
+    /**
+     * @deprecated
+     * As of TeamsJS v2.0.0, please use {@link app.AppInfo.sessionId | app.Context.app.sessionId} instead
+     *
+     * Unique ID for the current session for use in correlating telemetry data. A session corresponds to the lifecycle of an app. A new session begins upon the creation of a webview (on Teams mobile) or iframe (in Teams desktop) hosting the app, and ends when it is destroyed.
+     */
+    appSessionId?: string;
+    /**
+     * @deprecated
+     * As of TeamsJS v2.0.0, please use {@link app.AppInfo.appLaunchId | app.Context.app.appLaunchId} instead
+     *
+     * ID for the current visible app which is different for across cached sessions. Used for correlating telemetry data``
+     */
+    appLaunchId?: string;
+    /**
+     * @deprecated
+     * As of TeamsJS v2.0.0, please use {@link app.UserInfo.isCallingAllowed | app.Context.user.isCallingAllowed} instead
+     *
+     * Represents whether calling is allowed for the current logged in User
+     */
+    isCallingAllowed?: boolean;
+    /**
+     * @deprecated
+     * As of TeamsJS v2.0.0, please use {@link app.UserInfo.isPSTNCallingAllowed | app.Context.user.isPSTNCallingAllowed} instead
+     *
+     * Represents whether PSTN calling is allowed for the current logged in User
+     */
+    isPSTNCallingAllowed?: boolean;
+    /**
+     * @deprecated
+     * As of TeamsJS v2.0.0, please use {@link app.MeetingInfo.id | app.Context.meeting.id} instead
+     *
+     * Meeting Id used by tab when running in meeting context
+     */
+    meetingId?: string;
+    /**
+     * @deprecated
+     * As of TeamsJS v2.0.0, please use {@link app.ChannelInfo.defaultOneNoteSectionId | app.Context.channel.defaultOneNoteSectionId} instead
+     *
+     * The OneNote section ID that is linked to the channel.
+     */
+    defaultOneNoteSectionId?: string;
+    /**
+     * @deprecated
+     * As of TeamsJS v2.0.0, please use {@link app.PageInfo.isMultiWindow | app.Context.page.isMultiWindow} instead
+     *
+     * Indication whether the tab is in a pop out window
+     */
+    isMultiWindow?: boolean;
+    /**
+     * @deprecated
+     * As of TeamsJS v2.0.0, please use {@link app.PageInfo.isBackgroundLoad | app.Context.page.isBackgroundLoad} instead
+     *
+     * Indication whether the tab is being loaded in the background
+     */
+    isBackgroundLoad?: boolean;
+    /**
+     * @deprecated
+     * As of TeamsJS v2.0.0, please use {@link app.AppInfo.iconPositionVertical | app.Context.app.iconPositionVertical} instead
+     *
+     * Personal app icon y coordinate position
+     */
+    appIconPosition?: number;
+    /**
+     * @deprecated
+     * As of TeamsJS v2.0.0, please use {@link app.PageInfo.sourceOrigin | app.Context.page.sourceOrigin} instead
+     *
+     * Source origin from where the tab is opened
+     */
+    sourceOrigin?: string;
+    /**
+     * @deprecated
+     * As of TeamsJS v2.0.0, please use {@link app.AppInfo.userClickTime | app.Context.app.userClickTime} instead
+     *
+     * Time when the user clicked on the tab
+     */
+    userClickTime?: number;
+    /**
+     * @deprecated
+     * As of TeamsJS v2.0.0, please use {@link app.TeamInfo.templateId | app.Context.team.templateId} instead
+     *
+     * Team Template ID if there was a Team Template associated with the creation of the team.
+     */
+    teamTemplateId?: string;
+    /**
+     * @deprecated
+     * As of TeamsJS v2.0.0, please use {@link app.AppInfo.userFileOpenPreference | app.Context.app.userFileOpenPreference} instead
+     *
+     * Where the user prefers the file to be opened from by default during file open
+     */
+    userFileOpenPreference?: FileOpenPreference;
+    /**
+     * @deprecated
+     * As of TeamsJS v2.0.0, please use {@link app.UserInfo.displayName | app.Context.user.displayName} instead
+     *
+     * The address book name of the current user.
+     */
+    userDisplayName?: string;
+    /**
+     * @deprecated
+     * As of TeamsJS v2.0.0, please use {@link app.SharePointSiteInfo.teamSiteId | app.Context.sharePointSite.teamSiteId} instead
+     *
+     * Teamsite ID, aka sharepoint site id.
+     */
+    teamSiteId?: string;
+    /**
+     * @deprecated
+     * As of TeamsJS v2.0.0, please use {@link app.SharePointSiteInfo.mySiteDomain | app.Context.sharePointSite.mySiteDomain} instead
+     *
+     * The SharePoint my site domain associated with the user.
+     */
+    mySiteDomain?: string;
+    /**
+     * @deprecated
+     * As of TeamsJS v2.0.0, please use {@link app.SharePointSiteInfo.mySitePath | app.Context.sharePointSite.mySitePath} instead
+     *
+     * The SharePoint relative path to the current users mysite
+     */
+    mySitePath?: string;
+    /**
+     * @deprecated
+     * As of TeamsJS v2.0.0, please use {@link app.Context.dialogParameters} instead
+     *
+     * When `processActionCommand` activates a dialog, this dialog should automatically fill in some fields with information. This information comes from M365 and is given to `processActionCommand` as `extractedParameters`.
+     * App developers need to use these `extractedParameters` in their dialog.
+     * They help pre-fill the dialog with necessary information (`dialogParameters`) along with other details.
+     */
+    dialogParameters?: Record<string, string>;
+}
+/** Represents the parameters used to share a deep link. */
+export interface ShareDeepLinkParameters {
+    /**
+     * The developer-defined unique ID for the sub-page to which this deep link points in the current page.
+     * This field should be used to restore to a specific state within a page, such as scrolling to or activating a specific piece of content.
+     */
+    subPageId: string;
+    /**
+     * The label for the sub-page that should be displayed when the deep link is rendered in a client.
+     */
+    subPageLabel: string;
+    /**
+     * The fallback URL to which to navigate the user if the client cannot render the page.
+     * This URL should lead directly to the sub-entity.
+     */
+    subPageWebUrl?: string;
+}
+/**
+ * @deprecated
+ * As of TeamsJS v2.0.0, please use {@link ShareDeepLinkParameters} instead.
+ */
+export interface DeepLinkParameters {
+    /**
+     * The developer-defined unique ID for the sub-entity to which this deep link points in the current entity.
+     * 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.
+     */
+    subEntityId: string;
+    /**
+     * The label for the sub-entity that should be displayed when the deep link is rendered in a client.
+     */
+    subEntityLabel: string;
+    /**
+     * The fallback URL to which to navigate the user if the client cannot render the page.
+     * This URL should lead directly to the sub-entity.
+     */
+    subEntityWebUrl?: string;
+}
+/**
+ * @hidden
+ * Shared Dialog Properties
+ */
+export interface BaseDialogInfo {
+    /**
+     * The requested size of the dialog
+     */
+    size: DialogSize;
+    /**
+     * Title of the dialog module.
+     */
+    title?: string;
+}
+/**
+ * Data structure to describe dialog information needed to open an Adaptive Card-based dialog.
+ */
+export interface AdaptiveCardDialogInfo extends BaseDialogInfo {
+    /**
+     * JSON defining an Adaptive Card.
+     */
+    card: string;
+}
+/**
+ * Data structure to describe dialog information needed to open a bot-based Adaptive Card-based dialog.
+ */
+export interface BotAdaptiveCardDialogInfo extends AdaptiveCardDialogInfo {
+    /**
+     * Specifies a bot ID to send the result of the user's interaction with the dialog module.
+     * The bot will receive a task/complete invoke event with a JSON object
+     * in the event payload.
+     */
+    completionBotId: string;
+}
+/**
+ * Data structure to represent the size of a dialog
+ */
+export interface DialogSize {
+    /**
+     * The requested height of the webview/iframe.
+     */
+    height: DialogDimension | number;
+    /**
+     * The requested width of the webview/iframe.
+     */
+    width: DialogDimension | number;
+}
+/**
+ * Data structure to describe dialog information needed to open a url-based dialog.
+ */
+export interface UrlDialogInfo extends BaseDialogInfo {
+    /**
+     * The url to be rendered in the webview/iframe.
+     *
+     * @remarks
+     * The domain of the url must match at least one of the
+     * valid domains specified in the [validDomains block](https://learn.microsoft.com/microsoftteams/platform/resources/schema/manifest-schema#validdomains) of the app manifest
+     */
+    url: string;
+    /**
+     * If client doesnt support the URL, the URL that needs to be opened in the browser.
+     */
+    fallbackUrl?: string;
+}
+/**
+ * Data structure to describe dialog information needed to open a bot based dialog.
+ */
+export interface BotUrlDialogInfo extends UrlDialogInfo {
+    /**
+     * Specifies a bot ID to send the result of the user's interaction with the task module.
+     * The bot will receive a task/complete invoke event with a JSON object
+     * in the event payload.
+     */
+    completionBotId: string;
+}
+/**
+ * Data structure to describe dialog information
+ */
+export interface DialogInfo {
+    /**
+     * The url to be rendered in the webview/iframe.
+     *
+     * @remarks
+     * The domain of the url must match at least one of the
+     * valid domains specified in the validDomains block of the manifest
+     */
+    url?: string;
+    /**
+     * JSON defining an adaptive card.
+     */
+    card?: string;
+    /**
+     * The requested height of the webview/iframe.
+     */
+    height?: DialogDimension | number;
+    /**
+     * The requested width of the webview/iframe.
+     */
+    width?: DialogDimension | number;
+    /**
+     * Title of the task module.
+     */
+    title?: string;
+    /**
+     * If client doesnt support the URL, the URL that needs to be opened in the browser.
+     */
+    fallbackUrl?: string;
+    /**
+     * Specifies a bot ID to send the result of the user's interaction with the task module.
+     * If specified, the bot will receive a task/complete invoke event with a JSON object
+     * in the event payload.
+     */
+    completionBotId?: string;
+}
+/**
+ * @deprecated
+ * As of TeamsJS v2.0.0, please use {@link DialogInfo} instead.
+ */
+export type TaskInfo = DialogInfo;
+/**
+ * @beta
+ * Data structure to be used with the {@link app.lifecycle.registerOnResumeHandler app.lifecycle.registerOnResumeHandler(handler: (context: ResumeContext) => void): void} to pass the context to the app.
+ */
+export interface ResumeContext {
+    /**
+     * The entity that is requested to be loaded
+     */
+    entityId: string;
+    /**
+     * The content URL that is requested to be loaded
+     */
+    contentUrl: URL;
+}
+/**
+ * @deprecated
+ * As of 2.14.1, please use {@link ResumeContext} instead.
+ */
+export interface LoadContext {
+    /**
+     * The entity that is requested to be loaded
+     */
+    entityId: string;
+    /**
+     * The content URL that is requested to be loaded
+     */
+    contentUrl: string;
+}
+/** Represents information about a frame within a tab or dialog module. */
+export interface FrameInfo {
+    /**
+     * The current URL that needs to be used in the iframe if the tab is reloaded
+     */
+    contentUrl: string;
+    /**
+     * The current URL that needs to be used for opening the website when the user clicks on 'Go to website'
+     */
+    websiteUrl: string;
+}
+/**
+ * @deprecated
+ * As of TeamsJS v2.0.0, please use {@link FrameInfo} instead.
+ */
+export type FrameContext = FrameInfo;
+/** Represents an error that occurs during the execution of an app or integration. */
+export interface SdkError {
+    /**
+    error code
+    */
+    errorCode: ErrorCode;
+    /**
+    Optional description for the error. This may contain useful information for web-app developers.
+    This string will not be localized and is not for end-user consumption.
+    App should not depend on the string content. The exact value may change. This is only for debugging purposes.
+    */
+    message?: string;
+}
+export declare function isSdkError(err: unknown): err is SdkError;
+/** Error codes used to identify different types of errors that can occur while developing apps. */
+export declare enum ErrorCode {
+    /**
+     * API not supported in the current platform.
+     */
+    NOT_SUPPORTED_ON_PLATFORM = 100,
+    /**
+     * Internal error encountered while performing the required operation.
+     */
+    INTERNAL_ERROR = 500,
+    /**
+     * API is not supported in the current context
+     */
+    NOT_SUPPORTED_IN_CURRENT_CONTEXT = 501,
+    /**
+    Permissions denied by user
+    */
+    PERMISSION_DENIED = 1000,
+    /**
+     * Network issue
+     */
+    NETWORK_ERROR = 2000,
+    /**
+     * Underlying hardware doesn't support the capability
+     */
+    NO_HW_SUPPORT = 3000,
+    /**
+     * One or more arguments are invalid
+     */
+    INVALID_ARGUMENTS = 4000,
+    /**
+     * User is not authorized for this operation
+     */
+    UNAUTHORIZED_USER_OPERATION = 5000,
+    /**
+     * Could not complete the operation due to insufficient resources
+     */
+    INSUFFICIENT_RESOURCES = 6000,
+    /**
+     * Platform throttled the request because of API was invoked too frequently
+     */
+    THROTTLE = 7000,
+    /**
+     * User aborted the operation
+     */
+    USER_ABORT = 8000,
+    /**
+     * Could not complete the operation in the given time interval
+     */
+    OPERATION_TIMED_OUT = 8001,
+    /**
+     * Platform code is old and doesn't implement this API
+     */
+    OLD_PLATFORM = 9000,
+    /**
+     * The file specified was not found on the given location
+     */
+    FILE_NOT_FOUND = 404,
+    /**
+     * The return value is too big and has exceeded our size boundries
+     */
+    SIZE_EXCEEDED = 10000
+}
+/** @hidden */
+export declare enum DevicePermission {
+    GeoLocation = "geolocation",
+    Media = "media"
+}
+/** @hidden */
+export interface HostVersionsInfo {
+    adaptiveCardSchemaVersion?: AdaptiveCardVersion;
+    appEligibilityInformation?: AppEligibilityInformation;
+}
+/**
+ * Represents the major and minor versions of the Adaptive Card schema in the current host
+ */
+export interface AdaptiveCardVersion {
+    /** Represents the major version number. */
+    majorVersion: number;
+    /** Represents the minor version number. */
+    minorVersion: number;
+}
+/**
+ * @hidden
+ * Eligibility Information for the app user.
+ *
+ * @beta
+ */
+export interface AppEligibilityInformation {
+    /**
+     * Describes the user’s age group, which can have implications on which product they are able to use.
+     */
+    ageGroup: LegalAgeGroupClassification | null;
+    /**
+     * Describes the user’s chat experience based on their eligible licenses & their tenant’s eligible licenses.
+     * A user will be in at most one cohort.
+     */
+    cohort: Cohort | null;
+    /**
+     * Indicates that the user is eligible for Microsoft Entra ID Authenticated Copilot experience.
+     */
+    isCopilotEligible: boolean;
+    /**
+     * Implementation may change to be based on tenant-home region rather than IP.
+     */
+    isCopilotEnabledRegion: boolean;
+    /**
+     * Indicates if the tenant admin has opted the user out of Copilot.
+     */
+    isOptedOutByAdmin: boolean;
+    /**
+     * Education Eligibility Information for the app user
+     */
+    userClassification: UserClassification | null;
+}
+/**
+ * @hidden
+ *
+ * @beta
+ */
+export interface UserClassificationWithEduType {
+    /**
+     * For EDU tenants only. Indicates if the tenant is higher ed or K12.
+     */
+    eduType: EduType;
+    /**
+     * Describes additional traits of the user that contribute to FRE experience, etc.
+     */
+    persona: Persona.Faculty | Persona.Student;
+}
+/**
+ * @hidden
+ *
+ * @beta
+ */
+export interface UserClassificationWithOtherType {
+    persona: Persona.Other;
+}
+/**
+ * @hidden
+ *
+ * @beta
+ */
+export type UserClassification = UserClassificationWithEduType | UserClassificationWithOtherType;
+/**
+ * @hidden
+ *
+ * @beta
+ */
+export declare enum Cohort {
+    BCAIS = "bcais",
+    BCWAF = "bcwaf",
+    BCWBF = "bcwbf"
+}
+/**
+ * @hidden
+ *
+ * @beta
+ */
+export declare enum Persona {
+    /**
+     * User has a faculty license
+     */
+    Faculty = "faculty",
+    /**
+     * User has a student license
+     */
+    Student = "student",
+    /**
+     * When user is not a faculty or student
+     */
+    Other = "other"
+}
+/**
+ * @hidden
+ *
+ * @beta
+ */
+export declare enum LegalAgeGroupClassification {
+    /**
+     * The user is considered an adult based on the age-related regulations of their country or region.
+     */
+    Adult = "adult",
+    /**
+     * The user is a minor but is from a country or region that has no age-related regulations.
+     */
+    MinorNoParentalConsentRequired = "minorNoParentalConsentRequired",
+    /**
+     * Reserved for future use
+     */
+    MinorWithoutParentalConsent = "minorWithoutParentalConsent",
+    /**
+     * The user is considered a minor based on the age-related regulations of their country or region, and the administrator
+     * of the account obtained appropriate consent from a parent or guardian.
+     */
+    MinorWithParentalConsent = "minorWithParentalConsent",
+    /**
+     * The user is from a country or region that has additional age-related regulations, such as the United States,
+     * United Kingdom, European Union, or South Korea, and the user's age is between a minor and an adult age
+     * (as stipulated based on country or region). Generally, this means that teenagers are considered as notAdult in regulated countries.
+     */
+    NonAdult = "nonAdult"
+}
+/**
+ * @hidden
+ *
+ * @beta
+ */
+export declare enum EduType {
+    /**
+     * User is from a tenant labeled as “HigherEd”
+     */
+    HigherEducation = "higherEducation",
+    /**
+     * User is from a tenant labeled as “K12”
+     */
+    K12 = "k12",
+    /**
+     * User is from a tenant labeled as “Others” (e.g. research institutions)
+     */
+    Other = "other"
+}
+/**
+ * Currently supported Mime type
+ */
+export declare enum ClipboardSupportedMimeType {
+    TextPlain = "text/plain",
+    TextHtml = "text/html",
+    ImagePNG = "image/png",
+    ImageJPEG = "image/jpeg"
+}
+/**
+ * Clipboard write parameters
+ */
+export interface ClipboardParams {
+    /** Mime Type of data to be copied to Clipboard */
+    mimeType: ClipboardSupportedMimeType;
+    /** Blob content in Base64 string format */
+    content: string;
+}