@microsoft/teams-js 2.0.0-beta.7-dev.5 → 2.0.0-beta.7-dev.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -200,7 +200,7 @@ export function uploadCustomApp(manifestBlob: Blob, onComplete?: (status: boolea
200
200
  /**
201
201
  * @hidden
202
202
  * Internal use only
203
- * Sends a custom action MessageRequest to Teams or parent window
203
+ * Sends a custom action MessageRequest to host or parent window
204
204
  *
205
205
  * @param actionName - Specifies name of the custom action to be sent
206
206
  * @param args - Specifies additional arguments passed to the action
@@ -693,7 +693,7 @@ export namespace files {
693
693
  * Hide from docs
694
694
  * ------
695
695
  *
696
- * Open a cloud storage file in teams
696
+ * Open a cloud storage file in Teams
697
697
  *
698
698
  * @param file - cloud storage file that should be opened
699
699
  * @param providerCode - Code of the cloud storage folder provider
@@ -735,45 +735,6 @@ export namespace files {
735
735
  export {};
736
736
  }
737
737
 
738
- /**
739
- * @internal
740
- */
741
- export namespace legacy {
742
- namespace fullTrust {
743
- namespace joinedTeams {
744
- /**
745
- * @hidden
746
- * Hide from docs
747
- * ------
748
- * Allows an app to retrieve information of all user joined teams
749
- *
750
- * @param teamInstanceParameters - OPTIONAL Flags that specify whether to scope call to favorite teams
751
- * @returns Promise resolved containing information about the user joined teams or rejected with error
752
- */
753
- function getUserJoinedTeams(teamInstanceParameters?: TeamInstanceParameters): Promise<UserJoinedTeamsInformation>;
754
- function isSupported(): boolean;
755
- }
756
- /**
757
- * @hidden
758
- * Hide from docs
759
- * ------
760
- * Allows an app to get the configuration setting value
761
- *
762
- * @param key - The key for the config setting
763
- * @returns Promise resolved containing the value for the provided config setting or rejected with error
764
- */
765
- function getConfigSetting(key: string): Promise<string>;
766
- /**
767
- * Checks if teams.fullTrust capability is supported currently
768
- */
769
- function isSupported(): boolean;
770
- }
771
- /**
772
- * Checks if teams capability is supported currently
773
- */
774
- function isSupported(): boolean;
775
- }
776
-
777
738
  export namespace meetingRoom {
778
739
  /**
779
740
  * @hidden
@@ -1183,7 +1144,7 @@ export namespace appEntity {
1183
1144
  interface AppEntity {
1184
1145
  /**
1185
1146
  * @hidden
1186
- * App ID of the application
1147
+ * ID of the application
1187
1148
  */
1188
1149
  appId: string;
1189
1150
  /**
@@ -1213,14 +1174,19 @@ export namespace appEntity {
1213
1174
  * --------
1214
1175
  * Open the Tab Gallery and retrieve the app entity
1215
1176
  * @param threadId ID of the thread where the app entity will be created
1216
- * @param categories A list of app categories that will be displayed in the opened tab gallery
1177
+ * @param categories A list of application categories that will be displayed in the opened tab gallery
1217
1178
  * @param subEntityId An object that will be made available to the application being configured
1218
- * through the Teams Context's subEntityId field.
1179
+ * through the Context's subEntityId field.
1219
1180
  * @param callback Callback that will be triggered once the app entity information is available.
1220
1181
  * The callback takes two arguments: an SdkError in case something happened (i.e.
1221
1182
  * no permissions to execute the API) and the app entity configuration, if available
1222
1183
  */
1223
1184
  function selectAppEntity(threadId: string, categories: string[], subEntityId: string, callback: (sdkError?: SdkError, appEntity?: AppEntity) => void): void;
1185
+ /**
1186
+ * Checks if appEntity capability is supported by the host
1187
+ * @returns true if the appEntity capability is enabled in runtime.supports.appEntity and
1188
+ * false if it is disabled
1189
+ */
1224
1190
  function isSupported(): boolean;
1225
1191
  }
1226
1192
 
@@ -1263,7 +1229,64 @@ export namespace teams {
1263
1229
  * provided, the threadId from route params will be used.
1264
1230
  */
1265
1231
  function refreshSiteUrl(threadId: string, callback: (error: SdkError) => void): void;
1232
+ /**
1233
+ * @hidden
1234
+ * Checks if teams capability is supported by the host
1235
+ *
1236
+ * @returns true if the teams capability is enabled in runtime.supports.teams and
1237
+ * false if it is disabled
1238
+ */
1266
1239
  function isSupported(): boolean;
1240
+ /**
1241
+ * @hidden
1242
+ * Hide from docs
1243
+ * ------
1244
+ *
1245
+ * @internal
1246
+ */
1247
+ namespace fullTrust {
1248
+ namespace joinedTeams {
1249
+ /**
1250
+ * @hidden
1251
+ * Hide from docs
1252
+ * ------
1253
+ * Allows an app to retrieve information of all user joined teams
1254
+ *
1255
+ * @param teamInstanceParameters - Optional flags that specify whether to scope call to favorite teams
1256
+ * @returns Promise that resolves with information about the user joined teams or rejects with an error when the operation has completed
1257
+ */
1258
+ function getUserJoinedTeams(teamInstanceParameters?: TeamInstanceParameters): Promise<UserJoinedTeamsInformation>;
1259
+ /**
1260
+ * @hidden
1261
+ * Hide from docs
1262
+ * ------
1263
+ * Checks if teams.fullTrust.joinedTeams capability is supported by the host
1264
+ *
1265
+ * @returns true if the teams.fullTrust.joinedTeams capability is enabled in
1266
+ * runtime.supports.teams.fullTrust.joinedTeams and false if it is disabled
1267
+ */
1268
+ function isSupported(): boolean;
1269
+ }
1270
+ /**
1271
+ * @hidden
1272
+ * Hide from docs
1273
+ * ------
1274
+ * Allows an app to get the configuration setting value
1275
+ *
1276
+ * @param key - The key for the config setting
1277
+ * @returns Promise that resolves with the value for the provided configuration setting or rejects with an error when the operation has completed
1278
+ */
1279
+ function getConfigSetting(key: string): Promise<string>;
1280
+ /**
1281
+ * @hidden
1282
+ * Hide from docs
1283
+ * ------
1284
+ * Checks if teams.fullTrust capability is supported by the host
1285
+ * @returns true if the teams.fullTrust capability is enabled in runtime.supports.teams.fullTrust and
1286
+ * false if it is disabled
1287
+ */
1288
+ function isSupported(): boolean;
1289
+ }
1267
1290
  }
1268
1291
 
1269
1292
  /**
@@ -1563,7 +1586,7 @@ export enum HostClientType {
1563
1586
  ipados = "ipados",
1564
1587
  /**
1565
1588
  * @deprecated
1566
- * As of 2.0.0-beta.1, please use {@link teamsRoomsWindows} instead.
1589
+ * As of 2.0.0, please use {@link teamsRoomsWindows} instead.
1567
1590
  */
1568
1591
  rigel = "rigel",
1569
1592
  surfaceHub = "surfaceHub",
@@ -1617,7 +1640,7 @@ export enum DialogDimension {
1617
1640
  }
1618
1641
  /**
1619
1642
  * @deprecated
1620
- * As of 2.0.0-beta.1, please use {@link DialogDimension} instead.
1643
+ * As of 2.0.0, please use {@link DialogDimension} instead.
1621
1644
  */
1622
1645
  export import TaskModuleDimension = DialogDimension;
1623
1646
  /**
@@ -1771,8 +1794,13 @@ export enum FileOpenPreference {
1771
1794
  }
1772
1795
  /**
1773
1796
  * @deprecated
1774
- * As of 2.0.0-beta.1, please use {@link app.Context} instead.
1775
- * Represents structure of the received context message.
1797
+ * As of 2.0.0, please use {@link app.Context} instead.
1798
+ *
1799
+ * @remarks
1800
+ * For more details on the updated {@link app.Context} interface, visit
1801
+ * {@link https://docs.microsoft.com/microsoftteams/platform/tabs/how-to/using-teams-client-sdk#updates-to-the-context-interface}.
1802
+ *
1803
+ * Represents the structure of the received context message.
1776
1804
  */
1777
1805
  export interface Context {
1778
1806
  /**
@@ -1834,7 +1862,7 @@ export interface Context {
1834
1862
  /**
1835
1863
  * @hidden
1836
1864
  * @deprecated
1837
- * As of 2.0.0-beta.1, please use {@link loginHint} or {@link userPrincipalName} instead.
1865
+ * As of 2.0.0, please use {@link loginHint} or {@link userPrincipalName} instead.
1838
1866
  * The UPN of the current user.
1839
1867
  * Because a malicious party can run your content in a browser, this value should
1840
1868
  * be used only as a hint as to who the user is and never as proof of identity.
@@ -2082,7 +2110,7 @@ export interface ShareDeepLinkParameters {
2082
2110
  }
2083
2111
  /**
2084
2112
  * @deprecated
2085
- * As of 2.0.0-beta.5, please use {@link ShareDeepLinkParameters} instead.
2113
+ * As of 2.0.0, please use {@link ShareDeepLinkParameters} instead.
2086
2114
  */
2087
2115
  export interface DeepLinkParameters {
2088
2116
  /**
@@ -2184,7 +2212,7 @@ export interface DialogInfo {
2184
2212
  }
2185
2213
  /**
2186
2214
  * @deprecated
2187
- * As of 2.0.0-beta.1, please use {@link DialogInfo} instead.
2215
+ * As of 2.0.0, please use {@link DialogInfo} instead.
2188
2216
  */
2189
2217
  export type TaskInfo = DialogInfo;
2190
2218
  export interface DialogSize {
@@ -2221,7 +2249,7 @@ export interface FrameInfo {
2221
2249
  }
2222
2250
  /**
2223
2251
  * @deprecated
2224
- * As of 2.0.0-beta.1, please use {@link FrameInfo} instead.
2252
+ * As of 2.0.0, please use {@link FrameInfo} instead.
2225
2253
  */
2226
2254
  export type FrameContext = FrameInfo;
2227
2255
  export interface SdkError {
@@ -3007,17 +3035,17 @@ export namespace dialog {
3007
3035
  */
3008
3036
  export namespace pages {
3009
3037
  /**
3010
- * Return focus to the host. Will move focus forward or backward based on where the app container falls in
3011
- * the F6/Tab accessiblity loop in the host.
3038
+ * Return focus to the host. Will move focus forward or backward based on where the application container falls in
3039
+ * the F6/tab order in the host.
3012
3040
  * @param navigateForward - Determines the direction to focus in host.
3013
3041
  */
3014
3042
  function returnFocus(navigateForward?: boolean): void;
3015
3043
  /**
3016
3044
  * @hidden
3017
3045
  *
3018
- * Registers a handler when focus needs to be passed from teams to the place of choice on app.
3046
+ * Registers a handler for specifying focus when it passes from the host to the application.
3019
3047
  *
3020
- * @param handler - The handler to invoked by the app when they want the focus to be in the place of their choice.
3048
+ * @param handler - The handler for placing focus within the application.
3021
3049
  *
3022
3050
  * @internal
3023
3051
  */
@@ -3034,7 +3062,7 @@ export namespace pages {
3034
3062
  *
3035
3063
  * @param frameInfo - Frame information containing the URL used in the iframe on reload and the URL for when the
3036
3064
  * user clicks 'Go To Website'
3037
- * @param callback - An optional user-set callback that is executed once the app has finished initialization.
3065
+ * @param callback - An optional callback that is executed once the application has finished initialization.
3038
3066
  * @param validMessageOrigins - An optional list of cross-frame message origins. They must have
3039
3067
  * https: protocol otherwise they will be ignored. Example: https:www.example.com
3040
3068
  */
@@ -3074,19 +3102,19 @@ export namespace pages {
3074
3102
  * Navigates the frame to a new cross-domain URL. The domain of this URL must match at least one of the
3075
3103
  * valid domains specified in the validDomains block of the manifest; otherwise, an exception will be
3076
3104
  * thrown. This function needs to be used only when navigating the frame to a URL in a different domain
3077
- * than the current one in a way that keeps the app informed of the change and allows the SDK to
3105
+ * than the current one in a way that keeps the application informed of the change and allows the SDK to
3078
3106
  * continue working.
3079
3107
  * @param url - The URL to navigate the frame to.
3080
3108
  * @returns Promise that resolves when the navigation has completed.
3081
3109
  */
3082
3110
  function navigateCrossDomain(url: string): Promise<void>;
3083
3111
  /**
3084
- * Navigate to the given App ID and Page ID, with optional parameters for a WebURL (if the app cannot
3085
- * be navigated to, such as if it is not installed), Channel ID (for apps installed as a channel tab), and
3086
- * Sub-page ID (for navigating to specific content within the page). This is equivalent to navigating to
3087
- * a deep link with the above data, but does not require the app to build a URL or worry about different
3112
+ * Navigate to the given application ID and page ID, with optional parameters for a WebURL (if the application
3113
+ * cannot be navigated to, such as if it is not installed), Channel ID (for applications installed as a channel tab),
3114
+ * and sub-page ID (for navigating to specific content within the page). This is equivalent to navigating to
3115
+ * a deep link with the above data, but does not require the application to build a URL or worry about different
3088
3116
  * deep link formats for different hosts.
3089
- * @param params Parameters for the navigation
3117
+ * @param params - Parameters for the navigation
3090
3118
  * @returns a promise that will resolve if the navigation was successful
3091
3119
  */
3092
3120
  function navigateToApp(params: NavigateToAppParams): Promise<void>;
@@ -3103,7 +3131,7 @@ export namespace pages {
3103
3131
  */
3104
3132
  function registerFullScreenHandler(handler: (isFullScreen: boolean) => void): void;
3105
3133
  /**
3106
- * Checks if the current application host supports the pages capability
3134
+ * Checks if the pages capability is supported by the host
3107
3135
  * @returns true if the pages capability is enabled in runtime.supports.pages and
3108
3136
  * false if it is disabled
3109
3137
  */
@@ -3113,11 +3141,11 @@ export namespace pages {
3113
3141
  */
3114
3142
  interface NavigateToAppParams {
3115
3143
  /**
3116
- * ID of the App to navigate to
3144
+ * ID of the application to navigate to
3117
3145
  */
3118
3146
  appId: string;
3119
3147
  /**
3120
- * Developer-defined ID of the Page to navigate to within the app (Formerly EntityID)
3148
+ * Developer-defined ID of the Page to navigate to within the application (Formerly EntityID)
3121
3149
  */
3122
3150
  pageId: string;
3123
3151
  /**
@@ -3126,47 +3154,48 @@ export namespace pages {
3126
3154
  webUrl?: string;
3127
3155
  /**
3128
3156
  * Optional developer-defined ID describing the content to navigate to within the Page. This will be passed
3129
- * back to the App via the Context object.
3157
+ * back to the application via the Context object.
3130
3158
  */
3131
3159
  subPageId?: string;
3132
3160
  /**
3133
- * Optional ID of the Teams Channel where the app should be opened
3161
+ * Optional ID of the Teams Channel where the application should be opened
3134
3162
  */
3135
3163
  channelId?: string;
3136
3164
  }
3137
3165
  /**
3138
- * Namespace to interact with the teams specific part of the SDK.
3166
+ * Provides APIs for querying and navigating between contextual tabs of an application. Unlike personal tabs,
3167
+ * contextual tabs are pages associated with a specific context, such as channel or chat.
3139
3168
  */
3140
3169
  namespace tabs {
3141
3170
  /**
3142
- * Navigates the hosted app to the specified tab instance.
3143
- * @param tabInstance The tab instance to navigate to.
3171
+ * Navigates the hosted application to the specified tab instance.
3172
+ * @param tabInstance - The destination tab instance.
3144
3173
  * @returns Promise that resolves when the navigation has completed.
3145
3174
  */
3146
3175
  function navigateToTab(tabInstance: TabInstance): Promise<void>;
3147
3176
  /**
3148
- * Allows an app to retrieve for this user tabs that are owned by this app.
3149
- * If no TabInstanceParameters are passed, the app defaults to favorite teams and favorite channels.
3150
- * @param tabInstanceParameters OPTIONAL Flags that specify whether to scope call to favorite teams or channels.
3177
+ * Retrieves application tabs for the current user.
3178
+ * If no TabInstanceParameters are passed, the application defaults to favorite teams and favorite channels.
3179
+ * @param tabInstanceParameters - An optional set of flags that specify whether to scope call to favorite teams or channels.
3151
3180
  * @returns Promise that resolves with the {@link TabInformation}. Contains information for the user's tabs that are owned by this application {@link TabInstance}.
3152
3181
  */
3153
3182
  function getTabInstances(tabInstanceParameters?: TabInstanceParameters): Promise<TabInformation>;
3154
3183
  /**
3155
- * Allows an app to retrieve the most recently used tabs for this user.
3156
- * @param tabInstanceParameters OPTIONAL Ignored, kept for future use.
3184
+ * Retrieves the most recently used application tabs for the current user.
3185
+ * @param tabInstanceParameters - An optional set of flags. Note this is currently ignored and kept for future use.
3157
3186
  * @returns Promise that resolves with the {@link TabInformation}. Contains information for the users' most recently used tabs {@link TabInstance}.
3158
3187
  */
3159
3188
  function getMruTabInstances(tabInstanceParameters?: TabInstanceParameters): Promise<TabInformation>;
3160
3189
  /**
3161
- * Checks if the current application host supports the pages.tab capability
3190
+ * Checks if the pages.tab capability is supported by the host
3162
3191
  * @returns true if the pages.tabs capability is enabled in runtime.supports.pages.tabs and
3163
3192
  * false if it is disabled
3164
3193
  */
3165
3194
  function isSupported(): boolean;
3166
3195
  }
3167
3196
  /**
3168
- * Namespace to interact with the config-specific part of the SDK.
3169
- * This object is usable only on the config frame.
3197
+ * Provides APIs to interact with the configuration-specific part of the SDK.
3198
+ * This object is usable only on the configuration frame.
3170
3199
  */
3171
3200
  namespace config {
3172
3201
  /**
@@ -3178,24 +3207,24 @@ export namespace pages {
3178
3207
  */
3179
3208
  function initialize(): void;
3180
3209
  /**
3181
- * Sets the validity state for the config.
3182
- * The initial value is false, so the user cannot save the config until this is called with true.
3183
- * @param validityState Indicates whether the save or remove button is enabled for the user.
3210
+ * Sets the validity state for the configuration.
3211
+ * The initial value is false, so the user cannot save the configuration until this is called with true.
3212
+ * @param validityState - Indicates whether the save or remove button is enabled for the user.
3184
3213
  */
3185
3214
  function setValidityState(validityState: boolean): void;
3186
3215
  /**
3187
- * Sets the config for the current instance.
3216
+ * Sets the configuration for the current instance.
3188
3217
  * This is an asynchronous operation; calls to getConfig are not guaranteed to reflect the changed state.
3189
- * @param instanceConfig The desired config for this instance.
3218
+ * @param instanceConfig - The desired configuration for this instance.
3190
3219
  * @returns Promise that resolves when the operation has completed.
3191
3220
  */
3192
3221
  function setConfig(instanceConfig: InstanceConfig): Promise<void>;
3193
3222
  /**
3194
- * Registers a handler for when the user attempts to save the settings. This handler should be used
3223
+ * Registers a handler for when the user attempts to save the configuration. This handler should be used
3195
3224
  * to create or update the underlying resource powering the content.
3196
3225
  * The object passed to the handler must be used to notify whether to proceed with the save.
3197
3226
  * Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
3198
- * @param handler The handler to invoke when the user selects the save button.
3227
+ * @param handler - The handler to invoke when the user selects the Save button.
3199
3228
  */
3200
3229
  function registerOnSaveHandler(handler: (evt: SaveEvent) => void): void;
3201
3230
  /**
@@ -3203,12 +3232,12 @@ export namespace pages {
3203
3232
  * to remove the underlying resource powering the content.
3204
3233
  * The object passed to the handler must be used to indicate whether to proceed with the removal.
3205
3234
  * Only one handler may be registered at a time. Subsequent registrations will override the first.
3206
- * @param handler The handler to invoke when the user selects the remove button.
3235
+ * @param handler - The handler to invoke when the user selects the Remove button.
3207
3236
  */
3208
3237
  function registerOnRemoveHandler(handler: (evt: RemoveEvent) => void): void;
3209
3238
  /**
3210
3239
  * Registers a handler for when the tab configuration is changed by the user
3211
- * @param handler The handler to invoke when the user click on Settings.
3240
+ * @param handler - The handler to invoke when the user clicks on Settings.
3212
3241
  */
3213
3242
  function registerChangeConfigHandler(handler: () => void): void;
3214
3243
  /**
@@ -3226,7 +3255,7 @@ export namespace pages {
3226
3255
  notifySuccess(): void;
3227
3256
  /**
3228
3257
  * Indicates that creation of the underlying resource failed and that the config cannot be saved.
3229
- * @param reason Specifies a reason for the failure. If provided, this string is displayed to the user; otherwise a generic error is displayed.
3258
+ * @param reason - Specifies a reason for the failure. If provided, this string is displayed to the user; otherwise a generic error is displayed.
3230
3259
  */
3231
3260
  notifyFailure(reason?: string): void;
3232
3261
  }
@@ -3241,7 +3270,7 @@ export namespace pages {
3241
3270
  notifySuccess(): void;
3242
3271
  /**
3243
3272
  * Indicates that removal of the underlying resource failed and that the content cannot be removed.
3244
- * @param reason Specifies a reason for the failure. If provided, this string is displayed to the user; otherwise a generic error is displayed.
3273
+ * @param reason - Specifies a reason for the failure. If provided, this string is displayed to the user; otherwise a generic error is displayed.
3245
3274
  */
3246
3275
  notifyFailure(reason?: string): void;
3247
3276
  }
@@ -3255,33 +3284,32 @@ export namespace pages {
3255
3284
  webhookUrl?: string;
3256
3285
  }
3257
3286
  /**
3258
- * Checks if the current application host supports the pages.config capability
3287
+ * Checks if the pages.config capability is supported by the host
3259
3288
  * @returns true if the pages.config capability is enabled in runtime.supports.pages.config and
3260
3289
  * false if it is disabled
3261
3290
  */
3262
3291
  function isSupported(): boolean;
3263
3292
  }
3264
3293
  /**
3265
- * Namespace to interact with the back-stack part of the SDK.
3294
+ * Provides APIs for handling the user's navigational history.
3266
3295
  */
3267
3296
  namespace backStack {
3268
3297
  function _initialize(): void;
3269
3298
  /**
3270
- * Navigates back in the hosted app. See registerBackButtonHandler for more information on when
3271
- * it's appropriate to use this method.
3299
+ * Navigates back in the hosted application. See {@link pages.backStack.registerBackButtonHandler} for notes on usage.
3272
3300
  * @returns Promise that resolves when the navigation has completed.
3273
3301
  */
3274
3302
  function navigateBack(): Promise<void>;
3275
3303
  /**
3276
- * Registers a handler for user presses of the Team client's back button. Experiences that maintain an internal
3277
- * navigation stack should use this handler to navigate the user back within their frame. If an app finds
3304
+ * Registers a handler for user presses of the host client's back button. Experiences that maintain an internal
3305
+ * navigation stack should use this handler to navigate the user back within their frame. If an application finds
3278
3306
  * that after running its back button handler it cannot handle the event it should call the navigateBack
3279
- * method to ask the Teams client to handle it instead.
3280
- * @param handler The handler to invoke when the user presses their Team client's back button.
3307
+ * method to ask the host client to handle it instead.
3308
+ * @param handler - The handler to invoke when the user presses the host client's back button.
3281
3309
  */
3282
3310
  function registerBackButtonHandler(handler: () => boolean): void;
3283
3311
  /**
3284
- * Checks if the current application host supports the pages.backStack capability
3312
+ * Checks if the pages.backStack capability is supported by the host
3285
3313
  * @returns true if the pages.backStack capability is enabled in runtime.supports.pages.backStack and
3286
3314
  * false if it is disabled
3287
3315
  */
@@ -3291,7 +3319,7 @@ export namespace pages {
3291
3319
  * @hidden
3292
3320
  * Hide from docs
3293
3321
  * ------
3294
- * Namespace to interact with the full-trust part of the SDK. Limited to 1P apps
3322
+ * Provides APIs to interact with the full-trust part of the SDK. Limited to 1P applications
3295
3323
  */
3296
3324
  namespace fullTrust {
3297
3325
  /**
@@ -3312,14 +3340,14 @@ export namespace pages {
3312
3340
  * @hidden
3313
3341
  * Hide from docs
3314
3342
  * ------
3315
- * Checks if the current application host supports the pages.fullTrust capability
3343
+ * Checks if the pages.fullTrust capability is supported by the host
3316
3344
  * @returns true if the pages.fullTrust capability is enabled in runtime.supports.pages.fullTrust and
3317
3345
  * false if it is disabled
3318
3346
  */
3319
3347
  function isSupported(): boolean;
3320
3348
  }
3321
3349
  /**
3322
- * Namespace to interact with the app button part of the SDK.
3350
+ * Provides APIs to interact with the app button part of the SDK.
3323
3351
  */
3324
3352
  namespace appButton {
3325
3353
  /**
@@ -3341,7 +3369,7 @@ export namespace pages {
3341
3369
  */
3342
3370
  function onHoverLeave(handler: () => void): void;
3343
3371
  /**
3344
- * Checks if pages.appButton capability is supported currently
3372
+ * Checks if pages.appButton capability is supported by the host
3345
3373
  * @returns true if the pages.appButton capability is enabled in runtime.supports.pages.appButton and
3346
3374
  * false if it is disabled
3347
3375
  */
@@ -3963,7 +3991,7 @@ export namespace location {
3963
3991
  function getLocation(props: LocationProps): Promise<Location>;
3964
3992
  /**
3965
3993
  * @deprecated
3966
- * As of 2.0.0-beta.1, please use {@link location.getLocation location.getLocation(props: LocationProps): Promise\<Location\>} instead.
3994
+ * As of 2.0.0, please use {@link location.getLocation location.getLocation(props: LocationProps): Promise\<Location\>} instead.
3967
3995
  * @param props {@link LocationProps} - Specifying how the location request is handled
3968
3996
  * @param callback - Callback to invoke when current user location is fetched
3969
3997
  */
@@ -3977,7 +4005,7 @@ export namespace location {
3977
4005
  function showLocation(location: Location): Promise<void>;
3978
4006
  /**
3979
4007
  * @deprecated
3980
- * As of 2.0.0-beta.1, please use {@link location.showLocation location.showLocation(location: Location): Promise\<void\>} instead.
4008
+ * As of 2.0.0, please use {@link location.showLocation location.showLocation(location: Location): Promise\<void\>} instead.
3981
4009
  * Shows the location on map corresponding to the given coordinates
3982
4010
  * @param location {@link Location} - which needs to be shown on map
3983
4011
  * @param callback - Callback to invoke when the location is opened on map
@@ -4297,7 +4325,7 @@ export namespace monetization {
4297
4325
  function openPurchaseExperience(planInfo?: PlanInfo): Promise<void>;
4298
4326
  /**
4299
4327
  * @deprecated
4300
- * As of 2.0.0-beta.3, please use {@link monetization.openPurchaseExperience monetization.openPurchaseExperience(planInfo?: PlanInfo): Promise\<void\>} instead.
4328
+ * As of 2.0.0, please use {@link monetization.openPurchaseExperience monetization.openPurchaseExperience(planInfo?: PlanInfo): Promise\<void\>} instead.
4301
4329
  *
4302
4330
  * @hidden
4303
4331
  * Hide from docs
@@ -4396,6 +4424,11 @@ export namespace teamsCore {
4396
4424
  * @internal
4397
4425
  */
4398
4426
  function registerBeforeUnloadHandler(handler: (readyToUnload: () => void) => boolean): void;
4427
+ /**
4428
+ * Checks if teamsCore capability is supported by the host
4429
+ * @returns true if the teamsCore capability is enabled in runtime.supports.teamsCore and
4430
+ * false if it is disabled
4431
+ */
4399
4432
  function isSupported(): boolean;
4400
4433
  }
4401
4434
 
@@ -4411,7 +4444,7 @@ export namespace people {
4411
4444
  function selectPeople(peoplePickerInputs?: PeoplePickerInputs): Promise<PeoplePickerResult[]>;
4412
4445
  /**
4413
4446
  * @deprecated
4414
- * As of 2.0.0-beta.1, please use {@link people.selectPeople people.selectPeople(peoplePickerInputs?: PeoplePickerInputs): Promise\<PeoplePickerResult[]\>} instead.
4447
+ * As of 2.0.0, please use {@link people.selectPeople people.selectPeople(peoplePickerInputs?: PeoplePickerInputs): Promise\<PeoplePickerResult[]\>} instead.
4415
4448
  *
4416
4449
  * Launches a people picker and allows the user to select one or more people from the list
4417
4450
  * If the app is added to personal app scope the people picker launched is org wide and if the app is added to a chat/channel, people picker launched is also limited to the members of chat/channel
@@ -4506,7 +4539,7 @@ export namespace video {
4506
4539
  NV12 = 0
4507
4540
  }
4508
4541
  /**
4509
- * Video frame configuration supplied to Teams to customize the generated video frame parameters, like format
4542
+ * Video frame configuration supplied to the host to customize the generated video frame parameters, like format
4510
4543
  */
4511
4544
  interface VideoFrameConfig {
4512
4545
  /**
@@ -4537,21 +4570,29 @@ export namespace video {
4537
4570
  type VideoEffectCallBack = (effectId: string | undefined) => void;
4538
4571
  /**
4539
4572
  * Register to read the video frames in Permissions section
4573
+ * @param frameCallback - The callback to invoke when registerForVideoFrame has completed
4574
+ * @param config - VideoFrameConfig to customize generated video frame parameters
4540
4575
  */
4541
4576
  function registerForVideoFrame(frameCallback: VideoFrameCallback, config: VideoFrameConfig): void;
4542
4577
  /**
4543
- * video extension should call this to notify Teams Client current selected effect parameter changed.
4544
- * If it's pre-meeting, Teams client will call videoEffectCallback immediately then use the videoEffect.
4545
- * in-meeting scenario, we will call videoEffectCallback when apply button clicked.
4578
+ * video extension should call this to notify host client that the current selected effect parameter changed.
4579
+ * If it's pre-meeting, host client will call videoEffectCallback immediately then use the videoEffect.
4580
+ * If it's the in-meeting scenario, we will call videoEffectCallback when apply button clicked.
4546
4581
  *
4547
4582
  * @param effectChangeType - the effect change type.
4548
4583
  * @param effectId - Newly selected effect id.
4549
4584
  */
4550
4585
  function notifySelectedVideoEffectChanged(effectChangeType: EffectChangeType, effectId: string | undefined): void;
4551
4586
  /**
4552
- * Register the video effect callback, Teams client uses this to notify the video extension the new video effect will by applied
4587
+ * Register the video effect callback, host client uses this to notify the video extension the new video effect will by applied
4588
+ * @param callback - The VideoEffectCallback to invoke when registerForVideoEffect has completed
4553
4589
  */
4554
4590
  function registerForVideoEffect(callback: VideoEffectCallBack): void;
4591
+ /**
4592
+ * Checks if video capability is supported by the host
4593
+ * @returns true if the video capability is enabled in runtime.supports.video and
4594
+ * false if it is disabled
4595
+ */
4555
4596
  function isSupported(): boolean;
4556
4597
  }
4557
4598
 
@@ -4592,7 +4633,7 @@ export namespace sharing {
4592
4633
  export function shareWebContent(shareWebContentRequest: IShareRequest<IShareRequestContentType>): Promise<void>;
4593
4634
  /**
4594
4635
  * @deprecated
4595
- * As of 2.0.0-beta.3, please use {@link sharing.shareWebContent sharing.shareWebContent(shareWebContentRequest: IShareRequest\<IShareRequestContentType\>): Promise\<void\>} instead.
4636
+ * As of 2.0.0, please use {@link sharing.shareWebContent sharing.shareWebContent(shareWebContentRequest: IShareRequest\<IShareRequestContentType\>): Promise\<void\>} instead.
4596
4637
  *
4597
4638
  * Feature is under development
4598
4639
  * Opens a share dialog for web content
@@ -4614,7 +4655,7 @@ export namespace stageView {
4614
4655
  */
4615
4656
  interface StageViewParams {
4616
4657
  /**
4617
- * The application ID of the Teams application to be opened.
4658
+ * The ID of the Teams application to be opened.
4618
4659
  */
4619
4660
  appId: string;
4620
4661
  /**
@@ -4630,11 +4671,11 @@ export namespace stageView {
4630
4671
  */
4631
4672
  title: string;
4632
4673
  /**
4633
- * The Teams app website URL.
4674
+ * The Teams application website URL.
4634
4675
  */
4635
4676
  websiteUrl?: string;
4636
4677
  /**
4637
- * The entity ID of the Teams app content being opened.
4678
+ * The entity ID of the Teams application content being opened.
4638
4679
  */
4639
4680
  entityId?: string;
4640
4681
  }
@@ -4642,9 +4683,9 @@ export namespace stageView {
4642
4683
  * @hidden
4643
4684
  * Feature is under development
4644
4685
  *
4645
- * Opens a stage view to display a Teams app
4646
- * @param stageViewParams The parameters to pass into the stage view.
4647
- *
4686
+ * Opens a stage view to display a Teams application
4687
+ * @param stageViewParams - The parameters to pass into the stage view.
4688
+ * @returns Promise that resolves once the stage view is closed.
4648
4689
  */
4649
4690
  function open(stageViewParams: StageViewParams): Promise<void>;
4650
4691
  /**
@@ -4652,11 +4693,11 @@ export namespace stageView {
4652
4693
  * Feature is under development
4653
4694
  *
4654
4695
  * @deprecated
4655
- * As of 2.0.0-beta.3, please use {@link stageView.open stageView.open(): Promise\<void\>} instead.
4696
+ * As of 2.0.0, please use {@link stageView.open stageView.open(): Promise\<void\>} instead.
4656
4697
  *
4657
- * Opens a stage view to display a Teams app
4658
- * @param stageViewParams The parameters to pass into the stage view.
4659
- * Optional; @param callback Callback that will be triggered once the stage view is closed.
4698
+ * Opens a stage view to display a Teams application
4699
+ * @param stageViewParams - The parameters to pass into the stage view.
4700
+ * @param callback - Optional callback that will be triggered once the stage view is closed.
4660
4701
  * The callback takes as an argument an SdkError in case something happened (i.e.
4661
4702
  * no permissions to execute the API)
4662
4703
  */
@@ -4688,51 +4729,51 @@ export namespace call {
4688
4729
 
4689
4730
  /**
4690
4731
  * @deprecated
4691
- * As of 2.0.0-beta.1, please use {@link app} namespace instead.
4732
+ * As of 2.0.0, please use {@link app} namespace instead.
4692
4733
  */
4693
4734
  export namespace appInitialization {
4694
4735
  /**
4695
4736
  * @deprecated
4696
- * As of 2.0.0-beta.1, please use {@link app.Messages} instead.
4737
+ * As of 2.0.0, please use {@link app.Messages} instead.
4697
4738
  */
4698
4739
  export import Messages = app.Messages;
4699
4740
  /**
4700
4741
  * @deprecated
4701
- * As of 2.0.0-beta.1, please use {@link app.FailedReason} instead.
4742
+ * As of 2.0.0, please use {@link app.FailedReason} instead.
4702
4743
  */
4703
4744
  export import FailedReason = app.FailedReason;
4704
4745
  /**
4705
4746
  * @deprecated
4706
- * As of 2.0.0-beta.1, please use {@link app.ExpectedFailureReason} instead.
4747
+ * As of 2.0.0, please use {@link app.ExpectedFailureReason} instead.
4707
4748
  */
4708
4749
  export import ExpectedFailureReason = app.ExpectedFailureReason;
4709
4750
  /**
4710
4751
  * @deprecated
4711
- * As of 2.0.0-beta.1, please use {@link app.IFailedRequest} instead.
4752
+ * As of 2.0.0, please use {@link app.IFailedRequest} instead.
4712
4753
  */
4713
4754
  export import IFailedRequest = app.IFailedRequest;
4714
4755
  /**
4715
4756
  * @deprecated
4716
- * As of 2.0.0-beta.1, please use {@link app.IExpectedFailureRequest} instead.
4757
+ * As of 2.0.0, please use {@link app.IExpectedFailureRequest} instead.
4717
4758
  */
4718
4759
  export import IExpectedFailureRequest = app.IExpectedFailureRequest;
4719
4760
  /**
4720
4761
  * @deprecated
4721
- * As of 2.0.0-beta.1, please use {@link app.notifyAppLoaded app.notifyAppLoaded(): void} instead.
4762
+ * As of 2.0.0, please use {@link app.notifyAppLoaded app.notifyAppLoaded(): void} instead.
4722
4763
  *
4723
4764
  * Notifies the frame that app has loaded and to hide the loading indicator if one is shown.
4724
4765
  */
4725
4766
  function notifyAppLoaded(): void;
4726
4767
  /**
4727
4768
  * @deprecated
4728
- * As of 2.0.0-beta.1, please use {@link app.notifySuccess app.notifySuccess(): void} instead.
4769
+ * As of 2.0.0, please use {@link app.notifySuccess app.notifySuccess(): void} instead.
4729
4770
  *
4730
4771
  * Notifies the frame that app initialization is successful and is ready for user interaction.
4731
4772
  */
4732
4773
  function notifySuccess(): void;
4733
4774
  /**
4734
4775
  * @deprecated
4735
- * As of 2.0.0-beta.1, please use {@link app.notifyFailure app.notifyFailure(appInitializationFailedRequest: IFailedRequest): void} instead.
4776
+ * As of 2.0.0, please use {@link app.notifyFailure app.notifyFailure(appInitializationFailedRequest: IFailedRequest): void} instead.
4736
4777
  *
4737
4778
  * Notifies the frame that app initialization has failed and to show an error page in its place.
4738
4779
  * @param appInitializationFailedRequest - The failure request containing the reason for why the app failed
@@ -4741,7 +4782,7 @@ export namespace appInitialization {
4741
4782
  function notifyFailure(appInitializationFailedRequest: IFailedRequest): void;
4742
4783
  /**
4743
4784
  * @deprecated
4744
- * As of 2.0.0-beta.1, please use {@link app.notifyExpectedFailure app.notifyExpectedFailure(expectedFailureRequest: IExpectedFailureRequest): void} instead.
4785
+ * As of 2.0.0, please use {@link app.notifyExpectedFailure app.notifyExpectedFailure(expectedFailureRequest: IExpectedFailureRequest): void} instead.
4745
4786
  *
4746
4787
  * Notifies the frame that app initialized with some expected errors.
4747
4788
  * @param expectedFailureRequest - The expected failure request containing the reason and an optional message
@@ -4751,7 +4792,7 @@ export namespace appInitialization {
4751
4792
 
4752
4793
  /**
4753
4794
  * @deprecated
4754
- * As of 2.0.0-beta.1, please use {@link app.initialize app.initialize(validMessageOrigins?: string[]): Promise\<void\>} instead.
4795
+ * As of 2.0.0, please use {@link app.initialize app.initialize(validMessageOrigins?: string[]): Promise\<void\>} instead.
4755
4796
  *
4756
4797
  * Initializes the library. This must be called before any other SDK calls
4757
4798
  * but after the frame is loaded successfully.
@@ -4762,7 +4803,7 @@ export namespace appInitialization {
4762
4803
  export function initialize(callback?: () => void, validMessageOrigins?: string[]): void;
4763
4804
  /**
4764
4805
  * @deprecated
4765
- * As of 2.0.0-beta.1, please use {@link app._initialize app._initialize(hostWindow: any): void} instead.
4806
+ * As of 2.0.0, please use {@link app._initialize app._initialize(hostWindow: any): void} instead.
4766
4807
  *
4767
4808
  * @hidden
4768
4809
  * Hide from docs.
@@ -4774,7 +4815,7 @@ export function initialize(callback?: () => void, validMessageOrigins?: string[]
4774
4815
  export function _initialize(hostWindow: any): void;
4775
4816
  /**
4776
4817
  * @deprecated
4777
- * As of 2.0.0-beta.1, please use {@link app._uninitialize app._uninitialize(): void} instead.
4818
+ * As of 2.0.0, please use {@link app._uninitialize app._uninitialize(): void} instead.
4778
4819
  *
4779
4820
  * @hidden
4780
4821
  * Hide from docs.
@@ -4786,21 +4827,21 @@ export function _initialize(hostWindow: any): void;
4786
4827
  export function _uninitialize(): void;
4787
4828
  /**
4788
4829
  * @deprecated
4789
- * As of 2.0.0-beta.1, please use {@link teamsCore.enablePrintCapability teamsCore.enablePrintCapability(): void} instead.
4830
+ * As of 2.0.0, please use {@link teamsCore.enablePrintCapability teamsCore.enablePrintCapability(): void} instead.
4790
4831
  *
4791
4832
  * Enable print capability to support printing page using Ctrl+P and cmd+P
4792
4833
  */
4793
4834
  export function enablePrintCapability(): void;
4794
4835
  /**
4795
4836
  * @deprecated
4796
- * As of 2.0.0-beta.1, please use {@link teamsCore.print teamsCore.print(): void} instead.
4837
+ * As of 2.0.0, please use {@link teamsCore.print teamsCore.print(): void} instead.
4797
4838
  *
4798
4839
  * Default print handler
4799
4840
  */
4800
4841
  export function print(): void;
4801
4842
  /**
4802
4843
  * @deprecated
4803
- * As of 2.0.0-beta.1, please use {@link app.getContext app.getContext(): Promise\<app.Context\>} instead.
4844
+ * As of 2.0.0, please use {@link app.getContext app.getContext(): Promise\<app.Context\>} instead.
4804
4845
  *
4805
4846
  * Retrieves the current context the frame is running in.
4806
4847
  *
@@ -4809,7 +4850,7 @@ export function print(): void;
4809
4850
  export function getContext(callback: (context: Context) => void): void;
4810
4851
  /**
4811
4852
  * @deprecated
4812
- * As of 2.0.0-beta.1, please use {@link app.registerOnThemeChangeHandler app.registerOnThemeChangeHandler(handler: (theme: string) => void): void} instead.
4853
+ * As of 2.0.0, please use {@link app.registerOnThemeChangeHandler app.registerOnThemeChangeHandler(handler: (theme: string) => void): void} instead.
4813
4854
  *
4814
4855
  * Registers a handler for theme changes.
4815
4856
  * Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
@@ -4819,7 +4860,7 @@ export function getContext(callback: (context: Context) => void): void;
4819
4860
  export function registerOnThemeChangeHandler(handler: (theme: string) => void): void;
4820
4861
  /**
4821
4862
  * @deprecated
4822
- * As of 2.0.0-beta.1, please use {@link pages.registerFullScreenHandler pages.registerFullScreenHandler(handler: (isFullScreen: boolean) => void): void} instead.
4863
+ * As of 2.0.0, please use {@link pages.registerFullScreenHandler pages.registerFullScreenHandler(handler: (isFullScreen: boolean) => void): void} instead.
4823
4864
  *
4824
4865
  * Registers a handler for changes from or to full-screen view for a tab.
4825
4866
  * Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
@@ -4829,7 +4870,7 @@ export function registerOnThemeChangeHandler(handler: (theme: string) => void):
4829
4870
  export function registerFullScreenHandler(handler: (isFullScreen: boolean) => void): void;
4830
4871
  /**
4831
4872
  * @deprecated
4832
- * As of 2.0.0-beta.1, please use {@link pages.appButton.onClick pages.appButton.onClick(handler: () => void): void} instead.
4873
+ * As of 2.0.0, please use {@link pages.appButton.onClick pages.appButton.onClick(handler: () => void): void} instead.
4833
4874
  *
4834
4875
  * Registers a handler for clicking the app button.
4835
4876
  * Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
@@ -4839,7 +4880,7 @@ export function registerFullScreenHandler(handler: (isFullScreen: boolean) => vo
4839
4880
  export function registerAppButtonClickHandler(handler: () => void): void;
4840
4881
  /**
4841
4882
  * @deprecated
4842
- * As of 2.0.0-beta.1, please use {@link pages.appButton.onHoverEnter pages.appButton.onHoverEnter(handler: () => void): void} instead.
4883
+ * As of 2.0.0, please use {@link pages.appButton.onHoverEnter pages.appButton.onHoverEnter(handler: () => void): void} instead.
4843
4884
  *
4844
4885
  * Registers a handler for entering hover of the app button.
4845
4886
  * Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
@@ -4849,7 +4890,7 @@ export function registerAppButtonClickHandler(handler: () => void): void;
4849
4890
  export function registerAppButtonHoverEnterHandler(handler: () => void): void;
4850
4891
  /**
4851
4892
  * @deprecated
4852
- * As of 2.0.0-beta.1, please use {@link pages.appButton.onHoverLeave pages.appButton.onHoverLeave(handler: () => void): void} instead.
4893
+ * As of 2.0.0, please use {@link pages.appButton.onHoverLeave pages.appButton.onHoverLeave(handler: () => void): void} instead.
4853
4894
  *
4854
4895
  * Registers a handler for exiting hover of the app button.
4855
4896
  * Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
@@ -4859,7 +4900,7 @@ export function registerAppButtonHoverEnterHandler(handler: () => void): void;
4859
4900
  export function registerAppButtonHoverLeaveHandler(handler: () => void): void;
4860
4901
  /**
4861
4902
  * @deprecated
4862
- * As of 2.0.0-beta.1, please use {@link pages.backStack.registerBackButtonHandler pages.backStack.registerBackButtonHandler(handler: () => boolean): void} instead.
4903
+ * As of 2.0.0, please use {@link pages.backStack.registerBackButtonHandler pages.backStack.registerBackButtonHandler(handler: () => boolean): void} instead.
4863
4904
  *
4864
4905
  * Registers a handler for user presses of the Team client's back button. Experiences that maintain an internal
4865
4906
  * navigation stack should use this handler to navigate the user back within their frame. If an app finds
@@ -4871,7 +4912,7 @@ export function registerAppButtonHoverLeaveHandler(handler: () => void): void;
4871
4912
  export function registerBackButtonHandler(handler: () => boolean): void;
4872
4913
  /**
4873
4914
  * @deprecated
4874
- * As of 2.0.0-beta.1, please use {@link teamsCore.registerOnLoadHandler teamsCore.registerOnLoadHandler(handler: (context: LoadContext) => void): void} instead.
4915
+ * As of 2.0.0, please use {@link teamsCore.registerOnLoadHandler teamsCore.registerOnLoadHandler(handler: (context: LoadContext) => void): void} instead.
4875
4916
  *
4876
4917
  * @hidden
4877
4918
  * Registers a handler to be called when the page has been requested to load.
@@ -4881,7 +4922,7 @@ export function registerBackButtonHandler(handler: () => boolean): void;
4881
4922
  export function registerOnLoadHandler(handler: (context: LoadContext) => void): void;
4882
4923
  /**
4883
4924
  * @deprecated
4884
- * As of 2.0.0-beta.1, please use {@link teamsCore.registerBeforeUnloadHandler teamsCore.registerBeforeUnloadHandler(handler: (readyToUnload: () => void) => boolean): void} instead.
4925
+ * As of 2.0.0, please use {@link teamsCore.registerBeforeUnloadHandler teamsCore.registerBeforeUnloadHandler(handler: (readyToUnload: () => void) => boolean): void} instead.
4885
4926
  *
4886
4927
  * @hidden
4887
4928
  * Registers a handler to be called before the page is unloaded.
@@ -4892,7 +4933,7 @@ export function registerOnLoadHandler(handler: (context: LoadContext) => void):
4892
4933
  export function registerBeforeUnloadHandler(handler: (readyToUnload: () => void) => boolean): void;
4893
4934
  /**
4894
4935
  * @deprecated
4895
- * As of 2.0.0-beta.3, please use {@link pages.registerFocusEnterHandler pages.registerFocusEnterHandler(handler: (navigateForward: boolean) => void): void} instead.
4936
+ * As of 2.0.0, please use {@link pages.registerFocusEnterHandler pages.registerFocusEnterHandler(handler: (navigateForward: boolean) => void): void} instead.
4896
4937
  *
4897
4938
  * @hidden
4898
4939
  * Registers a handler when focus needs to be passed from teams to the place of choice on app.
@@ -4902,7 +4943,7 @@ export function registerBeforeUnloadHandler(handler: (readyToUnload: () => void)
4902
4943
  export function registerFocusEnterHandler(handler: (navigateForward: boolean) => boolean): void;
4903
4944
  /**
4904
4945
  * @deprecated
4905
- * As of 2.0.0-beta.1, please use {@link pages.config.registerChangeConfigHandler pages.config.registerChangeConfigHandler(handler: () => void): void} instead.
4946
+ * As of 2.0.0, please use {@link pages.config.registerChangeConfigHandler pages.config.registerChangeConfigHandler(handler: () => void): void} instead.
4906
4947
  *
4907
4948
  * Registers a handler for when the user reconfigurated tab.
4908
4949
  *
@@ -4911,7 +4952,7 @@ export function registerFocusEnterHandler(handler: (navigateForward: boolean) =>
4911
4952
  export function registerEnterSettingsHandler(handler: () => void): void;
4912
4953
  /**
4913
4954
  * @deprecated
4914
- * As of 2.0.0-beta.1, please use {@link pages.tabs.getTabInstances pages.tabs.getTabInstances(tabInstanceParameters?: TabInstanceParameters): Promise\<TabInformation\>} instead.
4955
+ * As of 2.0.0, please use {@link pages.tabs.getTabInstances pages.tabs.getTabInstances(tabInstanceParameters?: TabInstanceParameters): Promise\<TabInformation\>} instead.
4915
4956
  *
4916
4957
  * Allows an app to retrieve for this user tabs that are owned by this app.
4917
4958
  * If no TabInstanceParameters are passed, the app defaults to favorite teams and favorite channels.
@@ -4922,7 +4963,7 @@ export function registerEnterSettingsHandler(handler: () => void): void;
4922
4963
  export function getTabInstances(callback: (tabInfo: TabInformation) => void, tabInstanceParameters?: TabInstanceParameters): void;
4923
4964
  /**
4924
4965
  * @deprecated
4925
- * As of 2.0.0-beta.1, please use {@link pages.tabs.getMruTabInstances pages.tabs.getMruTabInstances(tabInstanceParameters?: TabInstanceParameters): Promise\<TabInformation\>} instead.
4966
+ * As of 2.0.0, please use {@link pages.tabs.getMruTabInstances pages.tabs.getMruTabInstances(tabInstanceParameters?: TabInstanceParameters): Promise\<TabInformation\>} instead.
4926
4967
  *
4927
4968
  * Allows an app to retrieve the most recently used tabs for this user.
4928
4969
  *
@@ -4932,7 +4973,7 @@ export function getTabInstances(callback: (tabInfo: TabInformation) => void, tab
4932
4973
  export function getMruTabInstances(callback: (tabInfo: TabInformation) => void, tabInstanceParameters?: TabInstanceParameters): void;
4933
4974
  /**
4934
4975
  * @deprecated
4935
- * As of 2.0.0-beta.3, please use {@link pages.shareDeepLink pages.shareDeepLink(deepLinkParameters: DeepLinkParameters): void} instead.
4976
+ * As of 2.0.0, please use {@link pages.shareDeepLink pages.shareDeepLink(deepLinkParameters: DeepLinkParameters): void} instead.
4936
4977
  *
4937
4978
  * Shares a deep link that a user can use to navigate back to a specific state in this page.
4938
4979
  *
@@ -4941,7 +4982,7 @@ export function getMruTabInstances(callback: (tabInfo: TabInformation) => void,
4941
4982
  export function shareDeepLink(deepLinkParameters: DeepLinkParameters): void;
4942
4983
  /**
4943
4984
  * @deprecated
4944
- * As of 2.0.0-beta.3, please use {@link app.openLink core.openLink(deepLink: string): Promise\<void\>} instead.
4985
+ * As of 2.0.0, please use {@link app.openLink core.openLink(deepLink: string): Promise\<void\>} instead.
4945
4986
  *
4946
4987
  * Execute deep link API.
4947
4988
  *
@@ -4950,7 +4991,7 @@ export function shareDeepLink(deepLinkParameters: DeepLinkParameters): void;
4950
4991
  export function executeDeepLink(deepLink: string, onComplete?: (status: boolean, reason?: string) => void): void;
4951
4992
  /**
4952
4993
  * @deprecated
4953
- * As of 2.0.0-beta.1, please use {@link pages.setCurrentFrame pages.setCurrentFrame(frameInfo: FrameInfo): void} instead.
4994
+ * As of 2.0.0, please use {@link pages.setCurrentFrame pages.setCurrentFrame(frameInfo: FrameInfo): void} instead.
4954
4995
  *
4955
4996
  * Set the current Frame Context
4956
4997
  *
@@ -4959,7 +5000,7 @@ export function executeDeepLink(deepLink: string, onComplete?: (status: boolean,
4959
5000
  export function setFrameContext(frameContext: FrameContext): void;
4960
5001
  /**
4961
5002
  * @deprecated
4962
- * As of 2.0.0-beta.1, please use {@link pages.initializeWithFrameContext pages.initializeWithFrameContext(frameInfo: FrameInfo, callback?: () => void, validMessageOrigins?: string[],): void} instead.
5003
+ * As of 2.0.0, please use {@link pages.initializeWithFrameContext pages.initializeWithFrameContext(frameInfo: FrameInfo, callback?: () => void, validMessageOrigins?: string[],): void} instead.
4963
5004
  *
4964
5005
  * Initilize with FrameContext
4965
5006
  *
@@ -4972,7 +5013,7 @@ export function initializeWithFrameContext(frameContext: FrameContext, callback?
4972
5013
 
4973
5014
  /**
4974
5015
  * @deprecated
4975
- * As of 2.0.0-beta.1, please use {@link pages.returnFocus pages.returnFocus(navigateForward?: boolean): void} instead.
5016
+ * As of 2.0.0, please use {@link pages.returnFocus pages.returnFocus(navigateForward?: boolean): void} instead.
4976
5017
  *
4977
5018
  * Return focus to the main Teams app. Will focus search bar if navigating foward and app bar if navigating back.
4978
5019
  *
@@ -4981,7 +5022,7 @@ export function initializeWithFrameContext(frameContext: FrameContext, callback?
4981
5022
  export function returnFocus(navigateForward?: boolean): void;
4982
5023
  /**
4983
5024
  * @deprecated
4984
- * As of 2.0.0-beta.1, please use {@link pages.tabs.navigateToTab pages.tabs.navigateToTab(tabInstance: TabInstance): Promise\<void\>} instead.
5025
+ * As of 2.0.0, please use {@link pages.tabs.navigateToTab pages.tabs.navigateToTab(tabInstance: TabInstance): Promise\<void\>} instead.
4985
5026
  *
4986
5027
  * Navigates the Microsoft Teams app to the specified tab instance.
4987
5028
  *
@@ -4991,7 +5032,7 @@ export function returnFocus(navigateForward?: boolean): void;
4991
5032
  export function navigateToTab(tabInstance: TabInstance, onComplete?: (status: boolean, reason?: string) => void): void;
4992
5033
  /**
4993
5034
  * @deprecated
4994
- * As of 2.0.0-beta.1, please use {@link pages.navigateCrossDomain pages.navigateCrossDomain(url: string): Promise\<void\>} instead.
5035
+ * As of 2.0.0, please use {@link pages.navigateCrossDomain pages.navigateCrossDomain(url: string): Promise\<void\>} instead.
4995
5036
  *
4996
5037
  * Navigates the frame to a new cross-domain URL. The domain of this URL must match at least one of the
4997
5038
  * valid domains specified in the validDomains block of the manifest; otherwise, an exception will be
@@ -5005,7 +5046,7 @@ export function navigateToTab(tabInstance: TabInstance, onComplete?: (status: bo
5005
5046
  export function navigateCrossDomain(url: string, onComplete?: (status: boolean, reason?: string) => void): void;
5006
5047
  /**
5007
5048
  * @deprecated
5008
- * As of 2.0.0-beta.1, please use {@link pages.backStack.navigateBack pages.backStack.navigateBack(): Promise\<void\>} instead.
5049
+ * As of 2.0.0, please use {@link pages.backStack.navigateBack pages.backStack.navigateBack(): Promise\<void\>} instead.
5009
5050
  *
5010
5051
  * Navigates back in the Teams client.
5011
5052
  * See registerBackButtonHandler for more information on when it's appropriate to use this method.
@@ -5016,7 +5057,7 @@ export function navigateBack(onComplete?: (status: boolean, reason?: string) =>
5016
5057
 
5017
5058
  /**
5018
5059
  * @deprecated
5019
- * As of 2.0.0-beta.1, please use {@link pages.config} namespace instead.
5060
+ * As of 2.0.0, please use {@link pages.config} namespace instead.
5020
5061
  *
5021
5062
  * Namespace to interact with the settings-specific part of the SDK.
5022
5063
  * This object is usable only on the settings frame.
@@ -5024,35 +5065,35 @@ export function navigateBack(onComplete?: (status: boolean, reason?: string) =>
5024
5065
  export namespace settings {
5025
5066
  /**
5026
5067
  * @deprecated
5027
- * As of 2.0.0-beta.1, please use {@link pages.config.Config} instead.
5068
+ * As of 2.0.0, please use {@link pages.config.Config} instead.
5028
5069
  * @remarks
5029
5070
  * Renamed to config in pages.Config
5030
5071
  */
5031
5072
  export import Settings = pages.InstanceConfig;
5032
5073
  /**
5033
5074
  * @deprecated
5034
- * As of 2.0.0-beta.1, please use {@link pages.config.SaveEvent} instead.
5075
+ * As of 2.0.0, please use {@link pages.config.SaveEvent} instead.
5035
5076
  * @remarks
5036
5077
  * See pages.SaveEvent
5037
5078
  */
5038
5079
  export import SaveEvent = pages.config.SaveEvent;
5039
5080
  /**
5040
5081
  * @deprecated
5041
- * As of 2.0.0-beta.1, please use {@link pages.config.RemoveEvent} instead.
5082
+ * As of 2.0.0, please use {@link pages.config.RemoveEvent} instead.
5042
5083
  * @remarks
5043
5084
  * See pages.RemoveEvent
5044
5085
  */
5045
5086
  export import RemoveEvent = pages.config.RemoveEvent;
5046
5087
  /**
5047
5088
  * @deprecated
5048
- * As of 2.0.0-beta.1, please use {@link pages.config.SaveParameters} instead.
5089
+ * As of 2.0.0, please use {@link pages.config.SaveParameters} instead.
5049
5090
  * @remarks
5050
5091
  * See pages.SaveParameters
5051
5092
  */
5052
5093
  export import SaveParameters = pages.config.SaveParameters;
5053
5094
  /**
5054
5095
  * @deprecated
5055
- * As of 2.0.0-beta.1, please use {@link pages.config.setValidityState pages.config.setValidityState(validityState: boolean): void} instead.
5096
+ * As of 2.0.0, please use {@link pages.config.setValidityState pages.config.setValidityState(validityState: boolean): void} instead.
5056
5097
  *
5057
5098
  * Sets the validity state for the settings.
5058
5099
  * The initial value is false, so the user cannot save the settings until this is called with true.
@@ -5062,7 +5103,7 @@ export namespace settings {
5062
5103
  function setValidityState(validityState: boolean): void;
5063
5104
  /**
5064
5105
  * @deprecated
5065
- * As of 2.0.0-beta.1, please use {@link pages.config.getConfig pages.config.getConfig(): Promise\<Config\>} instead.
5106
+ * As of 2.0.0, please use {@link pages.config.getConfig pages.config.getConfig(): Promise\<Config\>} instead.
5066
5107
  *
5067
5108
  * Gets the settings for the current instance.
5068
5109
  *
@@ -5071,7 +5112,7 @@ export namespace settings {
5071
5112
  function getSettings(callback: (instanceSettings: Settings) => void): void;
5072
5113
  /**
5073
5114
  * @deprecated
5074
- * As of 2.0.0-beta.1, please use {@link pages.config.setConfig pages.config.setConfig(instanceSettings: Config): Promise\<void\>} instead.
5115
+ * As of 2.0.0, please use {@link pages.config.setConfig pages.config.setConfig(instanceSettings: Config): Promise\<void\>} instead.
5075
5116
  *
5076
5117
  * Sets the settings for the current instance.
5077
5118
  * This is an asynchronous operation; calls to getSettings are not guaranteed to reflect the changed state.
@@ -5081,7 +5122,7 @@ export namespace settings {
5081
5122
  function setSettings(instanceSettings: Settings, onComplete?: (status: boolean, reason?: string) => void): void;
5082
5123
  /**
5083
5124
  * @deprecated
5084
- * As of 2.0.0-beta.1, please use {@link pages.config.registerOnSaveHandler pages.config.registerOnSaveHandler(handler: (evt: SaveEvent) => void): void} instead.
5125
+ * As of 2.0.0, please use {@link pages.config.registerOnSaveHandler pages.config.registerOnSaveHandler(handler: (evt: SaveEvent) => void): void} instead.
5085
5126
  *
5086
5127
  * Registers a handler for when the user attempts to save the settings. This handler should be used
5087
5128
  * to create or update the underlying resource powering the content.
@@ -5093,7 +5134,7 @@ export namespace settings {
5093
5134
  function registerOnSaveHandler(handler: (evt: SaveEvent) => void): void;
5094
5135
  /**
5095
5136
  * @deprecated
5096
- * As of 2.0.0-beta.1, please use {@link pages.config.registerOnRemoveHandler pages.config.registerOnRemoveHandler(handler: (evt: RemoveEvent) => void): void} instead.
5137
+ * As of 2.0.0, please use {@link pages.config.registerOnRemoveHandler pages.config.registerOnRemoveHandler(handler: (evt: RemoveEvent) => void): void} instead.
5097
5138
  *
5098
5139
  * Registers a handler for user attempts to remove content. This handler should be used
5099
5140
  * to remove the underlying resource powering the content.
@@ -5107,7 +5148,7 @@ export namespace settings {
5107
5148
 
5108
5149
  /**
5109
5150
  * @deprecated
5110
- * As of 2.0.0-beta.1, please use {@link dialog} namespace instead.
5151
+ * As of 2.0.0, please use {@link dialog} namespace instead.
5111
5152
  *
5112
5153
  * Namespace to interact with the task module-specific part of the SDK.
5113
5154
  * This object is usable only on the content frame.
@@ -5116,7 +5157,7 @@ export namespace settings {
5116
5157
  export namespace tasks {
5117
5158
  /**
5118
5159
  * @deprecated
5119
- * As of 2.0.0-beta.4, please use {@link dialog.open(urlDialogInfo: UrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): PostMessageChannel} for url based dialogs
5160
+ * As of 2.0.0, please use {@link dialog.open(urlDialogInfo: UrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): PostMessageChannel} for url based dialogs
5120
5161
  * and {@link dialog.bot.open(botUrlDialogInfo: BotUrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): PostMessageChannel} for bot based dialogs.
5121
5162
  *
5122
5163
  * Allows an app to open the task module.
@@ -5127,7 +5168,7 @@ export namespace tasks {
5127
5168
  function startTask(taskInfo: TaskInfo, submitHandler?: (err: string, result: string | object) => void): IAppWindow;
5128
5169
  /**
5129
5170
  * @deprecated
5130
- * As of 2.0.0-beta.4, please use {@link dialog.update.resize dialog.update.resize(dimensions: DialogSize): void} instead.
5171
+ * As of 2.0.0, please use {@link dialog.update.resize dialog.update.resize(dimensions: DialogSize): void} instead.
5131
5172
  *
5132
5173
  * Update height/width task info properties.
5133
5174
  *
@@ -5136,7 +5177,7 @@ export namespace tasks {
5136
5177
  function updateTask(taskInfo: TaskInfo): void;
5137
5178
  /**
5138
5179
  * @deprecated
5139
- * As of 2.0.0-beta.1, please use {@link dialog.submit dialog.submit(result?: string | object, appIds?: string | string[]): void} instead.
5180
+ * As of 2.0.0, please use {@link dialog.submit dialog.submit(result?: string | object, appIds?: string | string[]): void} instead.
5140
5181
  *
5141
5182
  * Submit the task module.
5142
5183
  *