@microsoft/teams-js 2.1.0-beta.1 → 2.1.0-beta.4

package/dist/MicrosoftTeams.d.ts

@@ -1943,65 +1943,85 @@ export enum FileOpenPreference {
     */
 export interface Context {
         /**
-            * @hidden
+            * @deprecated
+            * As of 2.0.0, please use {@link 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;
         /**
-            * @hidden
+            * @deprecated
+            * As of 2.0.0, please use {@link app.Context.team.internalId} instead
+            *
             * The Microsoft Teams ID for the team with which the content is associated.
             */
         teamId?: string;
         /**
-            * @hidden
+            * @deprecated
+            * As of 2.0.0, please use {@link app.Context.team.displayName} instead
+            *
             * The name for the team with which the content is associated.
             */
         teamName?: string;
         /**
-            * @hidden
+            * @deprecated
+            * As of 2.0.0, please use {@link app.Context.channel.id} instead
+            *
             * The Microsoft Teams ID for the channel with which the content is associated.
             */
         channelId?: string;
         /**
-            * @hidden
+            * @deprecated
+            * As of 2.0.0, please use {@link app.Context.channel.displayName} instead
+            *
             * The name for the channel with which the content is associated.
             */
         channelName?: string;
         /**
-            * @hidden
+            * @deprecated
+            * As of 2.0.0, please use {@link app.Context.channel.membershipType} instead
+            *
             * The type of the channel with which the content is associated.
             */
         channelType?: ChannelType;
         /**
-            * @hidden
+            * @deprecated
+            * As of 2.0.0, please use {@link app.Context.page.id} instead
+            *
             * The developer-defined unique ID for the entity this content points to.
             */
         entityId: string;
         /**
-            * @hidden
+            * @deprecated
+            * As of 2.0.0, please use {@link 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;
         /**
-            * @hidden
+            * @deprecated
+            * As of 2.0.0, please use {@link 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;
         /**
-            * @hidden
+            * @deprecated
+            * As of 2.0.0, please use {@link 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;
         /**
-            * @hidden
             * @deprecated
-            * As of 2.0.0, please use {@link loginHint} or {@link userPrincipalName} instead.
+            *
+            * As of 2.0.0, please use {@link app.Context.user.loginHint} or {@link 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.
@@ -2009,7 +2029,9 @@ export interface Context {
             */
         upn?: string;
         /**
-            * @hidden
+            * @deprecated
+            * As of 2.0.0, please use {@link app.Context.user.tenant.id} instead
+            *
             * The Azure AD 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.
@@ -2017,69 +2039,95 @@ export interface Context {
             */
         tid?: string;
         /**
-            * @hidden
+            * @deprecated
+            * As of 2.0.0, please use {@link app.Context.app.theme} instead
+            *
             * The current UI theme.
             */
         theme?: string;
         /**
-            * @hidden
+            * @deprecated
+            * As of 2.0.0, please use {@link app.Context.page.isFullScreen} instead
+            *
             * Indication whether the tab is in full-screen mode.
             */
         isFullScreen?: boolean;
         /**
-            * @hidden
+            * @deprecated
+            * As of 2.0.0, please use {@link app.Context.team.type} instead
+            *
             * The type of the team.
             */
         teamType?: TeamType;
         /**
-            * @hidden
+            * @deprecated
+            * As of 2.0.0, please use {@link app.Context.sharePointSite.teamSiteUrl} instead
+            *
             * The root SharePoint site associated with the team.
             */
         teamSiteUrl?: string;
         /**
-            * @hidden
+            * @deprecated
+            * As of 2.0.0, please use {@link app.Context.sharePointSite.teamSiteDomain} instead
+            *
             * The domain of the root SharePoint site associated with the team.
             */
         teamSiteDomain?: string;
         /**
-            * @hidden
+            * @deprecated
+            * As of 2.0.0, please use {@link app.Context.sharePointSite.teamSitePath} instead
+            *
             * The relative path to the SharePoint site associated with the team.
             */
         teamSitePath?: string;
         /**
-            * @hidden
+            * @deprecated
+            * As of 2.0.0, please use {@link app.Context.channel.ownerTeamTenantId} instead
+            *
             * The tenant ID of the host team.
             */
         hostTeamTenantId?: string;
         /**
-            * @hidden
+            * @deprecated
+            * As of 2.0.0, please use {@link app.Context.channel.ownerGroupId} instead
+            *
             * The AAD group ID of the host team.
             */
         hostTeamGroupId?: string;
         /**
-            * @hidden
+            * @deprecated
+            * As of 2.0.0, please use {@link app.Context.channel.relativeUrl} instead
+            *
             * The relative path to the SharePoint folder associated with the channel.
             */
         channelRelativeUrl?: string;
         /**
-            * @hidden
+            * @deprecated
+            * As of 2.0.0, please use {@link app.Context.app.host.sessionId} instead
+            *
             * Unique ID for the current Teams session for use in correlating telemetry data.
             */
         sessionId?: string;
         /**
-            * @hidden
+            * @deprecated
+            * As of 2.0.0, please use {@link 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;
         /**
-            * @hidden
+            * @deprecated
+            * As of 2.0.0, please use {@link app.Context.chat.id} instead
+            *
             * The Microsoft Teams ID for the chat with which the content is associated.
             */
         chatId?: string;
         /**
-            * @hidden
+            * @deprecated
+            * As of 2.0.0, please use {@link app.Context.user.loginHint} instead
+            *
             * A value suitable for use as a login_hint when authenticating with Azure AD.
             * 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.
@@ -2087,7 +2135,9 @@ export interface Context {
             */
         loginHint?: string;
         /**
-            * @hidden
+            * @deprecated
+            * As of 2.0.0, please use {@link 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.
@@ -2095,7 +2145,9 @@ export interface Context {
             */
         userPrincipalName?: string;
         /**
-            * @hidden
+            * @deprecated
+            * As of 2.0.0, please use {@link app.Context.user.id} instead
+            *
             * The Azure AD 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.
@@ -2103,130 +2155,180 @@ export interface Context {
             */
         userObjectId?: string;
         /**
-            * @hidden
+            * @deprecated
+            * As of 2.0.0, please use {@link 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;
         /**
-            * @hidden
+            * @deprecated
+            * As of 2.0.0, please use {@link app.Context.host.name} instead
+            *
             * The name of the host client. Possible values are: Office, Orange, Outlook, Teams
             */
         hostName?: HostName;
         /**
-            * @hidden
+            * @deprecated
+            * As of 2.0.0, please use {@link app.Context.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;
         /**
-            * @hidden
+            * @deprecated
+            * As of 2.0.0, please use {@link app.Context.page.frameContext} instead
+            *
             * The context where tab url is loaded (content, task, setting, remove, sidePanel)
             */
         frameContext?: FrameContexts;
         /**
-            * @hidden
+            * @deprecated
+            * As of 2.0.0, please use {@link app.Context.sharepoint} instead
+            *
             * SharePoint context. This is only available when hosted in SharePoint.
             */
         sharepoint?: any;
         /**
-            * @hidden
+            * @deprecated
+            * As of 2.0.0, please use {@link app.Context.user.tenant.teamsSku} instead
+            *
             * The type of license for the current users tenant.
             */
         tenantSKU?: string;
         /**
-            * @hidden
+            * @deprecated
+            * As of 2.0.0, please use {@link app.Context.user.licenseType} instead
+            *
             * The license type for the current user.
             */
         userLicenseType?: string;
         /**
-            * @hidden
+            * @deprecated
+            * As of 2.0.0, please use {@link 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;
         /**
-            * @hidden
+            * @deprecated
+            * As of 2.0.0, please use {@link app.Context.app.host.ringId} instead
+            *
             * Current ring ID
             */
         ringId?: string;
         /**
-            * @hidden
+            * @deprecated
+            * As of 2.0.0, please use {@link app.Context.app.sessionId} instead
+            *
             * Unique ID for the current session for use in correlating telemetry data.
             */
         appSessionId?: string;
         /**
-            * @hidden
+            * @deprecated
+            * As of 2.0.0, please use {@link 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;
         /**
-            * @hidden
+            * @deprecated
+            * As of 2.0.0, please use {@link app.Context.user.isCallingAllowed} instead
+            *
             * Represents whether calling is allowed for the current logged in User
             */
         isCallingAllowed?: boolean;
         /**
-            * @hidden
+            * @deprecated
+            * As of 2.0.0, please use {@link app.Context.user.isPSTNCallingAllowed} instead
+            *
             * Represents whether PSTN calling is allowed for the current logged in User
             */
         isPSTNCallingAllowed?: boolean;
         /**
-            * @hidden
+            * @deprecated
+            * As of 2.0.0, please use {@link app.Context.meeting.id} instead
+            *
             * Meeting Id used by tab when running in meeting context
             */
         meetingId?: string;
         /**
-            * @hidden
+            * @deprecated
+            * As of 2.0.0, please use {@link app.Context.channel.defaultOneNoteSectionId} instead
+            *
             * The OneNote section ID that is linked to the channel.
             */
         defaultOneNoteSectionId?: string;
         /**
-            * @hidden
+            * @deprecated
+            * As of 2.0.0, please use {@link app.Context.page.isMultiWindow} instead
+            *
             * Indication whether the tab is in a pop out window
             */
         isMultiWindow?: boolean;
         /**
-            * @hidden
+            * @deprecated
+            * As of 2.0.0, please use {@link app.Context.app.iconPositionVertical} instead
+            *
             * Personal app icon y coordinate position
             */
         appIconPosition?: number;
         /**
-            * @hidden
+            * @deprecated
+            * As of 2.0.0, please use {@link app.Context.page.sourceOrigin} instead
+            *
             * Source origin from where the tab is opened
             */
         sourceOrigin?: string;
         /**
-            * @hidden
+            * @deprecated
+            * As of 2.0.0, please use {@link app.Context.app.userClickTime} instead
+            *
             * Time when the user clicked on the tab
             */
         userClickTime?: number;
         /**
-            * @hidden
+            * @deprecated
+            * As of 2.0.0, please use {@link app.Context.team.templateId} instead
+            *
             * Team Template ID if there was a Team Template associated with the creation of the team.
             */
         teamTemplateId?: string;
         /**
-            * @hidden
+            * @deprecated
+            * As of 2.0.0, please use {@link app.Context.app.userFileOpenPreference} instead
+            *
             * Where the user prefers the file to be opened from by default during file open
             */
         userFileOpenPreference?: FileOpenPreference;
         /**
-            * @hidden
+            * @deprecated
+            * As of 2.0.0, please use {@link app.Context.user.displayName} instead
+            *
             * The address book name of the current user.
             */
         userDisplayName?: string;
         /**
-            * @hidden
+            * @deprecated
+            * As of 2.0.0, please use {@link app.Context.sharePointSite.teamSiteId} instead
+            *
             * Teamsite ID, aka sharepoint site id.
             */
         teamSiteId?: string;
         /**
-            * @hidden
+            * @deprecated
+            * As of 2.0.0, please use {@link app.Context.sharePointSite.mySiteDomain} instead
+            *
             * The SharePoint my site domain associated with the user.
             */
         mySiteDomain?: string;
         /**
-            * @hidden
+            * @deprecated
+            * As of 2.0.0, please use {@link app.Context.sharePointSite.mySitePath} instead
+            *
             * The SharePoint relative path to the current users mysite
             */
         mySitePath?: string;
@@ -2313,6 +2415,9 @@ export interface BotUrlDialogInfo extends UrlDialogInfo {
             */
         completionBotId: string;
 }
+/**
+    * Data structure to describe dialog information
+    */
 export interface DialogInfo {
         /**
             * The url to be rendered in the webview/iframe.
@@ -4481,7 +4586,7 @@ export namespace meeting {
         function registerSpeakingStateChangeHandler(handler: (speakingState: ISpeakingState) => void): void;
         /**
             * Registers a handler for changes to the selfParticipant's (current user's) raiseHandState. If the selfParticipant raises their hand, isHandRaised
-            * will be true. By default and if the selfParticipant hand is lowered, isHandRaised will be false. This API will return {@link RaiseHandStateChangedEvent}
+            * will be true. By default and if the selfParticipant hand is lowered, isHandRaised will be false. This API will return {@link RaiseHandStateChangedEventData}
             * that will have the raiseHandState or an error object. Only one handler can be registered at a time. A subsequent registration
             * replaces an existing registration.
             *
@@ -4799,10 +4904,12 @@ export namespace profile {
 
 /**
     * Namespace to video extensibility of the SDK
+    * @beta
     */
 export namespace video {
         /**
             * Represents a video frame
+            * @beta
             */
         interface VideoFrame {
                 /**
@@ -4832,21 +4939,24 @@ export namespace video {
         }
         /**
             * Video frame format enum, currently only support NV12
+            * @beta
             */
         enum VideoFrameFormat {
                 NV12 = 0
         }
         /**
             * Video frame configuration supplied to the host to customize the generated video frame parameters, like format
+            * @beta
             */
         interface VideoFrameConfig {
                 /**
-                    * video format
+                    * Video format
                     */
                 format: VideoFrameFormat;
         }
         /**
-            *  Video effect change type enum
+            * Video effect change type enum
+            * @beta
             */
         enum EffectChangeType {
                 /**
@@ -4859,35 +4969,40 @@ export namespace video {
                 EffectDisabled = 1
         }
         /**
-            *  Video frame call back function definition
+            * Video frame call back function definition
+            * @beta
             */
         type VideoFrameCallback = (frame: VideoFrame, notifyVideoFrameProcessed: () => void, notifyError: (errorMessage: string) => void) => void;
         /**
-            *  Video effect change call back function definition
+            * Video effect change call back function definition
+            * @beta
             */
         type VideoEffectCallBack = (effectId: string | undefined) => void;
         /**
             * Register to read the video frames in Permissions section
+            * @beta
             * @param frameCallback - The callback to invoke when registerForVideoFrame has completed
             * @param config - VideoFrameConfig to customize generated video frame parameters
             */
         function registerForVideoFrame(frameCallback: VideoFrameCallback, config: VideoFrameConfig): void;
         /**
-            * video extension should call this to notify host client that the current selected effect parameter changed.
+            * Video extension should call this to notify host client that the current selected effect parameter changed.
             * If it's pre-meeting, host client will call videoEffectCallback immediately then use the videoEffect.
             * If it's the in-meeting scenario, we will call videoEffectCallback when apply button clicked.
-            *
+            * @beta
             * @param effectChangeType - the effect change type.
             * @param effectId - Newly selected effect id.
             */
         function notifySelectedVideoEffectChanged(effectChangeType: EffectChangeType, effectId: string | undefined): void;
         /**
             * Register the video effect callback, host client uses this to notify the video extension the new video effect will by applied
+            * @beta
             * @param callback - The VideoEffectCallback to invoke when registerForVideoEffect has completed
             */
         function registerForVideoEffect(callback: VideoEffectCallBack): void;
         /**
             * Checks if video capability is supported by the host
+            * @beta
             * @returns true if the video capability is enabled in runtime.supports.video and
             * false if it is disabled
             */
@@ -4988,6 +5103,30 @@ export namespace stageView {
         function open(stageViewParams: StageViewParams): Promise<void>;
 }
 
+/**
+    * Contains functionality to allow web apps to store data in webview cache
+    *
+    * @beta
+    */
+export namespace webStorage {
+        /**
+            * Checks if web storage gets cleared when a user logs out from host client
+            *
+            * @returns true is web storage gets cleared on logout and false if it does not
+            *
+            * @beta
+            */
+        function isWebStorageClearedOnUserLogOut(): boolean;
+        /**
+            * Checks if webStorage capability is supported by the host
+            * @returns true if the webStorage capability is enabled in runtime.supports.webStorage and
+            * false if it is disabled
+            *
+            * @beta
+            */
+        function isSupported(): boolean;
+}
+
 export namespace call {
         enum CallModalities {
                 Unknown = "unknown",
@@ -5401,7 +5540,7 @@ export namespace settings {
         function setValidityState(validityState: boolean): void;
         /**
             * @deprecated
-            * As of 2.0.0, please use {@link pages.config.getConfig pages.config.getConfig(): Promise\<Config\>} instead.
+            * As of 2.0.0, please use {@link pages.getConfig pages.getConfig(): Promise\<InstanceConfig\>} instead.
             *
             * Gets the settings for the current instance.
             *
@@ -5455,8 +5594,9 @@ export namespace settings {
 export namespace tasks {
         /**
             * @deprecated
-            * As of 2.0.0, please use {@link dialog.open(urlDialogInfo: UrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): PostMessageChannel} for url based dialogs
-            * and {@link dialog.bot.open(botUrlDialogInfo: BotUrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): PostMessageChannel} for bot based dialogs.
+            * As of 2.0.0, please use {@link dialog.open dialog.open(urlDialogInfo: UrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): void} for url based dialogs
+            * and {@link dialog.bot.open dialog.bot.open(botUrlDialogInfo: BotUrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): void} for bot based dialogs. In Teams,
+            * this function can be used for adaptive card based dialogs. Support for adaptive card based dialogs is coming to other hosts in the future.
             *
             * Allows an app to open the task module.
             *
@@ -5475,7 +5615,7 @@ export namespace tasks {
         function updateTask(taskInfo: TaskInfo): void;
         /**
             * @deprecated
-            * As of 2.0.0, please use {@link dialog.submit dialog.submit(result?: string | object, appIds?: string | string[]): void} instead.
+            * As of 2.0.0, please use {@link dialog.submit} instead.
             *
             * Submit the task module.
             *
@@ -5483,8 +5623,24 @@ export namespace tasks {
             * @param appIds - Helps to validate that the call originates from the same appId as the one that invoked the task module
             */
         function submitTask(result?: string | object, appIds?: string | string[]): void;
+        /**
+            * Converts {@link TaskInfo} to {@link UrlDialogInfo}
+            * @param taskInfo - TaskInfo object to convert
+            * @returns - Converted UrlDialogInfo object
+            */
         function getUrlDialogInfoFromTaskInfo(taskInfo: TaskInfo): UrlDialogInfo;
+        /**
+            * Converts {@link TaskInfo} to {@link BotUrlDialogInfo}
+            * @param taskInfo - TaskInfo object to convert
+            * @returns - converted BotUrlDialogInfo object
+            */
         function getBotUrlDialogInfoFromTaskInfo(taskInfo: TaskInfo): BotUrlDialogInfo;
+        /**
+            * Sets the height and width of the {@link TaskInfo} object to the original height and width, if initially specified,
+            * otherwise uses the height and width values corresponding to {@link TaskModuleDimension.Small}
+            * @param taskInfo TaskInfo object from which to extract size info, if specified
+            * @returns TaskInfo with height and width specified
+            */
         function getDefaultSizeIfNotProvided(taskInfo: TaskInfo): TaskInfo;
 }