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

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.
@@ -1563,7 +1563,7 @@ export enum HostClientType {
1563
1563
  ipados = "ipados",
1564
1564
  /**
1565
1565
  * @deprecated
1566
- * As of 2.0.0-beta.1, please use {@link teamsRoomsWindows} instead.
1566
+ * As of 2.0.0, please use {@link teamsRoomsWindows} instead.
1567
1567
  */
1568
1568
  rigel = "rigel",
1569
1569
  surfaceHub = "surfaceHub",
@@ -1617,7 +1617,7 @@ export enum DialogDimension {
1617
1617
  }
1618
1618
  /**
1619
1619
  * @deprecated
1620
- * As of 2.0.0-beta.1, please use {@link DialogDimension} instead.
1620
+ * As of 2.0.0, please use {@link DialogDimension} instead.
1621
1621
  */
1622
1622
  export import TaskModuleDimension = DialogDimension;
1623
1623
  /**
@@ -1771,8 +1771,13 @@ export enum FileOpenPreference {
1771
1771
  }
1772
1772
  /**
1773
1773
  * @deprecated
1774
- * As of 2.0.0-beta.1, please use {@link app.Context} instead.
1775
- * Represents structure of the received context message.
1774
+ * As of 2.0.0, please use {@link app.Context} instead.
1775
+ *
1776
+ * @remarks
1777
+ * For more details on the updated {@link app.Context} interface, visit
1778
+ * {@link https://docs.microsoft.com/microsoftteams/platform/tabs/how-to/using-teams-client-sdk#updates-to-the-context-interface}.
1779
+ *
1780
+ * Represents the structure of the received context message.
1776
1781
  */
1777
1782
  export interface Context {
1778
1783
  /**
@@ -1834,7 +1839,7 @@ export interface Context {
1834
1839
  /**
1835
1840
  * @hidden
1836
1841
  * @deprecated
1837
- * As of 2.0.0-beta.1, please use {@link loginHint} or {@link userPrincipalName} instead.
1842
+ * As of 2.0.0, please use {@link loginHint} or {@link userPrincipalName} instead.
1838
1843
  * The UPN of the current user.
1839
1844
  * Because a malicious party can run your content in a browser, this value should
1840
1845
  * be used only as a hint as to who the user is and never as proof of identity.
@@ -2082,7 +2087,7 @@ export interface ShareDeepLinkParameters {
2082
2087
  }
2083
2088
  /**
2084
2089
  * @deprecated
2085
- * As of 2.0.0-beta.5, please use {@link ShareDeepLinkParameters} instead.
2090
+ * As of 2.0.0, please use {@link ShareDeepLinkParameters} instead.
2086
2091
  */
2087
2092
  export interface DeepLinkParameters {
2088
2093
  /**
@@ -2184,7 +2189,7 @@ export interface DialogInfo {
2184
2189
  }
2185
2190
  /**
2186
2191
  * @deprecated
2187
- * As of 2.0.0-beta.1, please use {@link DialogInfo} instead.
2192
+ * As of 2.0.0, please use {@link DialogInfo} instead.
2188
2193
  */
2189
2194
  export type TaskInfo = DialogInfo;
2190
2195
  export interface DialogSize {
@@ -2221,7 +2226,7 @@ export interface FrameInfo {
2221
2226
  }
2222
2227
  /**
2223
2228
  * @deprecated
2224
- * As of 2.0.0-beta.1, please use {@link FrameInfo} instead.
2229
+ * As of 2.0.0, please use {@link FrameInfo} instead.
2225
2230
  */
2226
2231
  export type FrameContext = FrameInfo;
2227
2232
  export interface SdkError {
@@ -3963,7 +3968,7 @@ export namespace location {
3963
3968
  function getLocation(props: LocationProps): Promise<Location>;
3964
3969
  /**
3965
3970
  * @deprecated
3966
- * As of 2.0.0-beta.1, please use {@link location.getLocation location.getLocation(props: LocationProps): Promise\<Location\>} instead.
3971
+ * As of 2.0.0, please use {@link location.getLocation location.getLocation(props: LocationProps): Promise\<Location\>} instead.
3967
3972
  * @param props {@link LocationProps} - Specifying how the location request is handled
3968
3973
  * @param callback - Callback to invoke when current user location is fetched
3969
3974
  */
@@ -3977,7 +3982,7 @@ export namespace location {
3977
3982
  function showLocation(location: Location): Promise<void>;
3978
3983
  /**
3979
3984
  * @deprecated
3980
- * As of 2.0.0-beta.1, please use {@link location.showLocation location.showLocation(location: Location): Promise\<void\>} instead.
3985
+ * As of 2.0.0, please use {@link location.showLocation location.showLocation(location: Location): Promise\<void\>} instead.
3981
3986
  * Shows the location on map corresponding to the given coordinates
3982
3987
  * @param location {@link Location} - which needs to be shown on map
3983
3988
  * @param callback - Callback to invoke when the location is opened on map
@@ -4297,7 +4302,7 @@ export namespace monetization {
4297
4302
  function openPurchaseExperience(planInfo?: PlanInfo): Promise<void>;
4298
4303
  /**
4299
4304
  * @deprecated
4300
- * As of 2.0.0-beta.3, please use {@link monetization.openPurchaseExperience monetization.openPurchaseExperience(planInfo?: PlanInfo): Promise\<void\>} instead.
4305
+ * As of 2.0.0, please use {@link monetization.openPurchaseExperience monetization.openPurchaseExperience(planInfo?: PlanInfo): Promise\<void\>} instead.
4301
4306
  *
4302
4307
  * @hidden
4303
4308
  * Hide from docs
@@ -4411,7 +4416,7 @@ export namespace people {
4411
4416
  function selectPeople(peoplePickerInputs?: PeoplePickerInputs): Promise<PeoplePickerResult[]>;
4412
4417
  /**
4413
4418
  * @deprecated
4414
- * As of 2.0.0-beta.1, please use {@link people.selectPeople people.selectPeople(peoplePickerInputs?: PeoplePickerInputs): Promise\<PeoplePickerResult[]\>} instead.
4419
+ * As of 2.0.0, please use {@link people.selectPeople people.selectPeople(peoplePickerInputs?: PeoplePickerInputs): Promise\<PeoplePickerResult[]\>} instead.
4415
4420
  *
4416
4421
  * Launches a people picker and allows the user to select one or more people from the list
4417
4422
  * 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
@@ -4592,7 +4597,7 @@ export namespace sharing {
4592
4597
  export function shareWebContent(shareWebContentRequest: IShareRequest<IShareRequestContentType>): Promise<void>;
4593
4598
  /**
4594
4599
  * @deprecated
4595
- * As of 2.0.0-beta.3, please use {@link sharing.shareWebContent sharing.shareWebContent(shareWebContentRequest: IShareRequest\<IShareRequestContentType\>): Promise\<void\>} instead.
4600
+ * As of 2.0.0, please use {@link sharing.shareWebContent sharing.shareWebContent(shareWebContentRequest: IShareRequest\<IShareRequestContentType\>): Promise\<void\>} instead.
4596
4601
  *
4597
4602
  * Feature is under development
4598
4603
  * Opens a share dialog for web content
@@ -4652,7 +4657,7 @@ export namespace stageView {
4652
4657
  * Feature is under development
4653
4658
  *
4654
4659
  * @deprecated
4655
- * As of 2.0.0-beta.3, please use {@link stageView.open stageView.open(): Promise\<void\>} instead.
4660
+ * As of 2.0.0, please use {@link stageView.open stageView.open(): Promise\<void\>} instead.
4656
4661
  *
4657
4662
  * Opens a stage view to display a Teams app
4658
4663
  * @param stageViewParams The parameters to pass into the stage view.
@@ -4688,51 +4693,51 @@ export namespace call {
4688
4693
 
4689
4694
  /**
4690
4695
  * @deprecated
4691
- * As of 2.0.0-beta.1, please use {@link app} namespace instead.
4696
+ * As of 2.0.0, please use {@link app} namespace instead.
4692
4697
  */
4693
4698
  export namespace appInitialization {
4694
4699
  /**
4695
4700
  * @deprecated
4696
- * As of 2.0.0-beta.1, please use {@link app.Messages} instead.
4701
+ * As of 2.0.0, please use {@link app.Messages} instead.
4697
4702
  */
4698
4703
  export import Messages = app.Messages;
4699
4704
  /**
4700
4705
  * @deprecated
4701
- * As of 2.0.0-beta.1, please use {@link app.FailedReason} instead.
4706
+ * As of 2.0.0, please use {@link app.FailedReason} instead.
4702
4707
  */
4703
4708
  export import FailedReason = app.FailedReason;
4704
4709
  /**
4705
4710
  * @deprecated
4706
- * As of 2.0.0-beta.1, please use {@link app.ExpectedFailureReason} instead.
4711
+ * As of 2.0.0, please use {@link app.ExpectedFailureReason} instead.
4707
4712
  */
4708
4713
  export import ExpectedFailureReason = app.ExpectedFailureReason;
4709
4714
  /**
4710
4715
  * @deprecated
4711
- * As of 2.0.0-beta.1, please use {@link app.IFailedRequest} instead.
4716
+ * As of 2.0.0, please use {@link app.IFailedRequest} instead.
4712
4717
  */
4713
4718
  export import IFailedRequest = app.IFailedRequest;
4714
4719
  /**
4715
4720
  * @deprecated
4716
- * As of 2.0.0-beta.1, please use {@link app.IExpectedFailureRequest} instead.
4721
+ * As of 2.0.0, please use {@link app.IExpectedFailureRequest} instead.
4717
4722
  */
4718
4723
  export import IExpectedFailureRequest = app.IExpectedFailureRequest;
4719
4724
  /**
4720
4725
  * @deprecated
4721
- * As of 2.0.0-beta.1, please use {@link app.notifyAppLoaded app.notifyAppLoaded(): void} instead.
4726
+ * As of 2.0.0, please use {@link app.notifyAppLoaded app.notifyAppLoaded(): void} instead.
4722
4727
  *
4723
4728
  * Notifies the frame that app has loaded and to hide the loading indicator if one is shown.
4724
4729
  */
4725
4730
  function notifyAppLoaded(): void;
4726
4731
  /**
4727
4732
  * @deprecated
4728
- * As of 2.0.0-beta.1, please use {@link app.notifySuccess app.notifySuccess(): void} instead.
4733
+ * As of 2.0.0, please use {@link app.notifySuccess app.notifySuccess(): void} instead.
4729
4734
  *
4730
4735
  * Notifies the frame that app initialization is successful and is ready for user interaction.
4731
4736
  */
4732
4737
  function notifySuccess(): void;
4733
4738
  /**
4734
4739
  * @deprecated
4735
- * As of 2.0.0-beta.1, please use {@link app.notifyFailure app.notifyFailure(appInitializationFailedRequest: IFailedRequest): void} instead.
4740
+ * As of 2.0.0, please use {@link app.notifyFailure app.notifyFailure(appInitializationFailedRequest: IFailedRequest): void} instead.
4736
4741
  *
4737
4742
  * Notifies the frame that app initialization has failed and to show an error page in its place.
4738
4743
  * @param appInitializationFailedRequest - The failure request containing the reason for why the app failed
@@ -4741,7 +4746,7 @@ export namespace appInitialization {
4741
4746
  function notifyFailure(appInitializationFailedRequest: IFailedRequest): void;
4742
4747
  /**
4743
4748
  * @deprecated
4744
- * As of 2.0.0-beta.1, please use {@link app.notifyExpectedFailure app.notifyExpectedFailure(expectedFailureRequest: IExpectedFailureRequest): void} instead.
4749
+ * As of 2.0.0, please use {@link app.notifyExpectedFailure app.notifyExpectedFailure(expectedFailureRequest: IExpectedFailureRequest): void} instead.
4745
4750
  *
4746
4751
  * Notifies the frame that app initialized with some expected errors.
4747
4752
  * @param expectedFailureRequest - The expected failure request containing the reason and an optional message
@@ -4751,7 +4756,7 @@ export namespace appInitialization {
4751
4756
 
4752
4757
  /**
4753
4758
  * @deprecated
4754
- * As of 2.0.0-beta.1, please use {@link app.initialize app.initialize(validMessageOrigins?: string[]): Promise\<void\>} instead.
4759
+ * As of 2.0.0, please use {@link app.initialize app.initialize(validMessageOrigins?: string[]): Promise\<void\>} instead.
4755
4760
  *
4756
4761
  * Initializes the library. This must be called before any other SDK calls
4757
4762
  * but after the frame is loaded successfully.
@@ -4762,7 +4767,7 @@ export namespace appInitialization {
4762
4767
  export function initialize(callback?: () => void, validMessageOrigins?: string[]): void;
4763
4768
  /**
4764
4769
  * @deprecated
4765
- * As of 2.0.0-beta.1, please use {@link app._initialize app._initialize(hostWindow: any): void} instead.
4770
+ * As of 2.0.0, please use {@link app._initialize app._initialize(hostWindow: any): void} instead.
4766
4771
  *
4767
4772
  * @hidden
4768
4773
  * Hide from docs.
@@ -4774,7 +4779,7 @@ export function initialize(callback?: () => void, validMessageOrigins?: string[]
4774
4779
  export function _initialize(hostWindow: any): void;
4775
4780
  /**
4776
4781
  * @deprecated
4777
- * As of 2.0.0-beta.1, please use {@link app._uninitialize app._uninitialize(): void} instead.
4782
+ * As of 2.0.0, please use {@link app._uninitialize app._uninitialize(): void} instead.
4778
4783
  *
4779
4784
  * @hidden
4780
4785
  * Hide from docs.
@@ -4786,21 +4791,21 @@ export function _initialize(hostWindow: any): void;
4786
4791
  export function _uninitialize(): void;
4787
4792
  /**
4788
4793
  * @deprecated
4789
- * As of 2.0.0-beta.1, please use {@link teamsCore.enablePrintCapability teamsCore.enablePrintCapability(): void} instead.
4794
+ * As of 2.0.0, please use {@link teamsCore.enablePrintCapability teamsCore.enablePrintCapability(): void} instead.
4790
4795
  *
4791
4796
  * Enable print capability to support printing page using Ctrl+P and cmd+P
4792
4797
  */
4793
4798
  export function enablePrintCapability(): void;
4794
4799
  /**
4795
4800
  * @deprecated
4796
- * As of 2.0.0-beta.1, please use {@link teamsCore.print teamsCore.print(): void} instead.
4801
+ * As of 2.0.0, please use {@link teamsCore.print teamsCore.print(): void} instead.
4797
4802
  *
4798
4803
  * Default print handler
4799
4804
  */
4800
4805
  export function print(): void;
4801
4806
  /**
4802
4807
  * @deprecated
4803
- * As of 2.0.0-beta.1, please use {@link app.getContext app.getContext(): Promise\<app.Context\>} instead.
4808
+ * As of 2.0.0, please use {@link app.getContext app.getContext(): Promise\<app.Context\>} instead.
4804
4809
  *
4805
4810
  * Retrieves the current context the frame is running in.
4806
4811
  *
@@ -4809,7 +4814,7 @@ export function print(): void;
4809
4814
  export function getContext(callback: (context: Context) => void): void;
4810
4815
  /**
4811
4816
  * @deprecated
4812
- * As of 2.0.0-beta.1, please use {@link app.registerOnThemeChangeHandler app.registerOnThemeChangeHandler(handler: (theme: string) => void): void} instead.
4817
+ * As of 2.0.0, please use {@link app.registerOnThemeChangeHandler app.registerOnThemeChangeHandler(handler: (theme: string) => void): void} instead.
4813
4818
  *
4814
4819
  * Registers a handler for theme changes.
4815
4820
  * Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
@@ -4819,7 +4824,7 @@ export function getContext(callback: (context: Context) => void): void;
4819
4824
  export function registerOnThemeChangeHandler(handler: (theme: string) => void): void;
4820
4825
  /**
4821
4826
  * @deprecated
4822
- * As of 2.0.0-beta.1, please use {@link pages.registerFullScreenHandler pages.registerFullScreenHandler(handler: (isFullScreen: boolean) => void): void} instead.
4827
+ * As of 2.0.0, please use {@link pages.registerFullScreenHandler pages.registerFullScreenHandler(handler: (isFullScreen: boolean) => void): void} instead.
4823
4828
  *
4824
4829
  * Registers a handler for changes from or to full-screen view for a tab.
4825
4830
  * Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
@@ -4829,7 +4834,7 @@ export function registerOnThemeChangeHandler(handler: (theme: string) => void):
4829
4834
  export function registerFullScreenHandler(handler: (isFullScreen: boolean) => void): void;
4830
4835
  /**
4831
4836
  * @deprecated
4832
- * As of 2.0.0-beta.1, please use {@link pages.appButton.onClick pages.appButton.onClick(handler: () => void): void} instead.
4837
+ * As of 2.0.0, please use {@link pages.appButton.onClick pages.appButton.onClick(handler: () => void): void} instead.
4833
4838
  *
4834
4839
  * Registers a handler for clicking the app button.
4835
4840
  * Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
@@ -4839,7 +4844,7 @@ export function registerFullScreenHandler(handler: (isFullScreen: boolean) => vo
4839
4844
  export function registerAppButtonClickHandler(handler: () => void): void;
4840
4845
  /**
4841
4846
  * @deprecated
4842
- * As of 2.0.0-beta.1, please use {@link pages.appButton.onHoverEnter pages.appButton.onHoverEnter(handler: () => void): void} instead.
4847
+ * As of 2.0.0, please use {@link pages.appButton.onHoverEnter pages.appButton.onHoverEnter(handler: () => void): void} instead.
4843
4848
  *
4844
4849
  * Registers a handler for entering hover of the app button.
4845
4850
  * Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
@@ -4849,7 +4854,7 @@ export function registerAppButtonClickHandler(handler: () => void): void;
4849
4854
  export function registerAppButtonHoverEnterHandler(handler: () => void): void;
4850
4855
  /**
4851
4856
  * @deprecated
4852
- * As of 2.0.0-beta.1, please use {@link pages.appButton.onHoverLeave pages.appButton.onHoverLeave(handler: () => void): void} instead.
4857
+ * As of 2.0.0, please use {@link pages.appButton.onHoverLeave pages.appButton.onHoverLeave(handler: () => void): void} instead.
4853
4858
  *
4854
4859
  * Registers a handler for exiting hover of the app button.
4855
4860
  * Only one handler can be registered at a time. A subsequent registration replaces an existing registration.
@@ -4859,7 +4864,7 @@ export function registerAppButtonHoverEnterHandler(handler: () => void): void;
4859
4864
  export function registerAppButtonHoverLeaveHandler(handler: () => void): void;
4860
4865
  /**
4861
4866
  * @deprecated
4862
- * As of 2.0.0-beta.1, please use {@link pages.backStack.registerBackButtonHandler pages.backStack.registerBackButtonHandler(handler: () => boolean): void} instead.
4867
+ * As of 2.0.0, please use {@link pages.backStack.registerBackButtonHandler pages.backStack.registerBackButtonHandler(handler: () => boolean): void} instead.
4863
4868
  *
4864
4869
  * Registers a handler for user presses of the Team client's back button. Experiences that maintain an internal
4865
4870
  * navigation stack should use this handler to navigate the user back within their frame. If an app finds
@@ -4871,7 +4876,7 @@ export function registerAppButtonHoverLeaveHandler(handler: () => void): void;
4871
4876
  export function registerBackButtonHandler(handler: () => boolean): void;
4872
4877
  /**
4873
4878
  * @deprecated
4874
- * As of 2.0.0-beta.1, please use {@link teamsCore.registerOnLoadHandler teamsCore.registerOnLoadHandler(handler: (context: LoadContext) => void): void} instead.
4879
+ * As of 2.0.0, please use {@link teamsCore.registerOnLoadHandler teamsCore.registerOnLoadHandler(handler: (context: LoadContext) => void): void} instead.
4875
4880
  *
4876
4881
  * @hidden
4877
4882
  * Registers a handler to be called when the page has been requested to load.
@@ -4881,7 +4886,7 @@ export function registerBackButtonHandler(handler: () => boolean): void;
4881
4886
  export function registerOnLoadHandler(handler: (context: LoadContext) => void): void;
4882
4887
  /**
4883
4888
  * @deprecated
4884
- * As of 2.0.0-beta.1, please use {@link teamsCore.registerBeforeUnloadHandler teamsCore.registerBeforeUnloadHandler(handler: (readyToUnload: () => void) => boolean): void} instead.
4889
+ * As of 2.0.0, please use {@link teamsCore.registerBeforeUnloadHandler teamsCore.registerBeforeUnloadHandler(handler: (readyToUnload: () => void) => boolean): void} instead.
4885
4890
  *
4886
4891
  * @hidden
4887
4892
  * Registers a handler to be called before the page is unloaded.
@@ -4892,7 +4897,7 @@ export function registerOnLoadHandler(handler: (context: LoadContext) => void):
4892
4897
  export function registerBeforeUnloadHandler(handler: (readyToUnload: () => void) => boolean): void;
4893
4898
  /**
4894
4899
  * @deprecated
4895
- * As of 2.0.0-beta.3, please use {@link pages.registerFocusEnterHandler pages.registerFocusEnterHandler(handler: (navigateForward: boolean) => void): void} instead.
4900
+ * As of 2.0.0, please use {@link pages.registerFocusEnterHandler pages.registerFocusEnterHandler(handler: (navigateForward: boolean) => void): void} instead.
4896
4901
  *
4897
4902
  * @hidden
4898
4903
  * Registers a handler when focus needs to be passed from teams to the place of choice on app.
@@ -4902,7 +4907,7 @@ export function registerBeforeUnloadHandler(handler: (readyToUnload: () => void)
4902
4907
  export function registerFocusEnterHandler(handler: (navigateForward: boolean) => boolean): void;
4903
4908
  /**
4904
4909
  * @deprecated
4905
- * As of 2.0.0-beta.1, please use {@link pages.config.registerChangeConfigHandler pages.config.registerChangeConfigHandler(handler: () => void): void} instead.
4910
+ * As of 2.0.0, please use {@link pages.config.registerChangeConfigHandler pages.config.registerChangeConfigHandler(handler: () => void): void} instead.
4906
4911
  *
4907
4912
  * Registers a handler for when the user reconfigurated tab.
4908
4913
  *
@@ -4911,7 +4916,7 @@ export function registerFocusEnterHandler(handler: (navigateForward: boolean) =>
4911
4916
  export function registerEnterSettingsHandler(handler: () => void): void;
4912
4917
  /**
4913
4918
  * @deprecated
4914
- * As of 2.0.0-beta.1, please use {@link pages.tabs.getTabInstances pages.tabs.getTabInstances(tabInstanceParameters?: TabInstanceParameters): Promise\<TabInformation\>} instead.
4919
+ * As of 2.0.0, please use {@link pages.tabs.getTabInstances pages.tabs.getTabInstances(tabInstanceParameters?: TabInstanceParameters): Promise\<TabInformation\>} instead.
4915
4920
  *
4916
4921
  * Allows an app to retrieve for this user tabs that are owned by this app.
4917
4922
  * If no TabInstanceParameters are passed, the app defaults to favorite teams and favorite channels.
@@ -4922,7 +4927,7 @@ export function registerEnterSettingsHandler(handler: () => void): void;
4922
4927
  export function getTabInstances(callback: (tabInfo: TabInformation) => void, tabInstanceParameters?: TabInstanceParameters): void;
4923
4928
  /**
4924
4929
  * @deprecated
4925
- * As of 2.0.0-beta.1, please use {@link pages.tabs.getMruTabInstances pages.tabs.getMruTabInstances(tabInstanceParameters?: TabInstanceParameters): Promise\<TabInformation\>} instead.
4930
+ * As of 2.0.0, please use {@link pages.tabs.getMruTabInstances pages.tabs.getMruTabInstances(tabInstanceParameters?: TabInstanceParameters): Promise\<TabInformation\>} instead.
4926
4931
  *
4927
4932
  * Allows an app to retrieve the most recently used tabs for this user.
4928
4933
  *
@@ -4932,7 +4937,7 @@ export function getTabInstances(callback: (tabInfo: TabInformation) => void, tab
4932
4937
  export function getMruTabInstances(callback: (tabInfo: TabInformation) => void, tabInstanceParameters?: TabInstanceParameters): void;
4933
4938
  /**
4934
4939
  * @deprecated
4935
- * As of 2.0.0-beta.3, please use {@link pages.shareDeepLink pages.shareDeepLink(deepLinkParameters: DeepLinkParameters): void} instead.
4940
+ * As of 2.0.0, please use {@link pages.shareDeepLink pages.shareDeepLink(deepLinkParameters: DeepLinkParameters): void} instead.
4936
4941
  *
4937
4942
  * Shares a deep link that a user can use to navigate back to a specific state in this page.
4938
4943
  *
@@ -4941,7 +4946,7 @@ export function getMruTabInstances(callback: (tabInfo: TabInformation) => void,
4941
4946
  export function shareDeepLink(deepLinkParameters: DeepLinkParameters): void;
4942
4947
  /**
4943
4948
  * @deprecated
4944
- * As of 2.0.0-beta.3, please use {@link app.openLink core.openLink(deepLink: string): Promise\<void\>} instead.
4949
+ * As of 2.0.0, please use {@link app.openLink core.openLink(deepLink: string): Promise\<void\>} instead.
4945
4950
  *
4946
4951
  * Execute deep link API.
4947
4952
  *
@@ -4950,7 +4955,7 @@ export function shareDeepLink(deepLinkParameters: DeepLinkParameters): void;
4950
4955
  export function executeDeepLink(deepLink: string, onComplete?: (status: boolean, reason?: string) => void): void;
4951
4956
  /**
4952
4957
  * @deprecated
4953
- * As of 2.0.0-beta.1, please use {@link pages.setCurrentFrame pages.setCurrentFrame(frameInfo: FrameInfo): void} instead.
4958
+ * As of 2.0.0, please use {@link pages.setCurrentFrame pages.setCurrentFrame(frameInfo: FrameInfo): void} instead.
4954
4959
  *
4955
4960
  * Set the current Frame Context
4956
4961
  *
@@ -4959,7 +4964,7 @@ export function executeDeepLink(deepLink: string, onComplete?: (status: boolean,
4959
4964
  export function setFrameContext(frameContext: FrameContext): void;
4960
4965
  /**
4961
4966
  * @deprecated
4962
- * As of 2.0.0-beta.1, please use {@link pages.initializeWithFrameContext pages.initializeWithFrameContext(frameInfo: FrameInfo, callback?: () => void, validMessageOrigins?: string[],): void} instead.
4967
+ * As of 2.0.0, please use {@link pages.initializeWithFrameContext pages.initializeWithFrameContext(frameInfo: FrameInfo, callback?: () => void, validMessageOrigins?: string[],): void} instead.
4963
4968
  *
4964
4969
  * Initilize with FrameContext
4965
4970
  *
@@ -4972,7 +4977,7 @@ export function initializeWithFrameContext(frameContext: FrameContext, callback?
4972
4977
 
4973
4978
  /**
4974
4979
  * @deprecated
4975
- * As of 2.0.0-beta.1, please use {@link pages.returnFocus pages.returnFocus(navigateForward?: boolean): void} instead.
4980
+ * As of 2.0.0, please use {@link pages.returnFocus pages.returnFocus(navigateForward?: boolean): void} instead.
4976
4981
  *
4977
4982
  * Return focus to the main Teams app. Will focus search bar if navigating foward and app bar if navigating back.
4978
4983
  *
@@ -4981,7 +4986,7 @@ export function initializeWithFrameContext(frameContext: FrameContext, callback?
4981
4986
  export function returnFocus(navigateForward?: boolean): void;
4982
4987
  /**
4983
4988
  * @deprecated
4984
- * As of 2.0.0-beta.1, please use {@link pages.tabs.navigateToTab pages.tabs.navigateToTab(tabInstance: TabInstance): Promise\<void\>} instead.
4989
+ * As of 2.0.0, please use {@link pages.tabs.navigateToTab pages.tabs.navigateToTab(tabInstance: TabInstance): Promise\<void\>} instead.
4985
4990
  *
4986
4991
  * Navigates the Microsoft Teams app to the specified tab instance.
4987
4992
  *
@@ -4991,7 +4996,7 @@ export function returnFocus(navigateForward?: boolean): void;
4991
4996
  export function navigateToTab(tabInstance: TabInstance, onComplete?: (status: boolean, reason?: string) => void): void;
4992
4997
  /**
4993
4998
  * @deprecated
4994
- * As of 2.0.0-beta.1, please use {@link pages.navigateCrossDomain pages.navigateCrossDomain(url: string): Promise\<void\>} instead.
4999
+ * As of 2.0.0, please use {@link pages.navigateCrossDomain pages.navigateCrossDomain(url: string): Promise\<void\>} instead.
4995
5000
  *
4996
5001
  * Navigates the frame to a new cross-domain URL. The domain of this URL must match at least one of the
4997
5002
  * valid domains specified in the validDomains block of the manifest; otherwise, an exception will be
@@ -5005,7 +5010,7 @@ export function navigateToTab(tabInstance: TabInstance, onComplete?: (status: bo
5005
5010
  export function navigateCrossDomain(url: string, onComplete?: (status: boolean, reason?: string) => void): void;
5006
5011
  /**
5007
5012
  * @deprecated
5008
- * As of 2.0.0-beta.1, please use {@link pages.backStack.navigateBack pages.backStack.navigateBack(): Promise\<void\>} instead.
5013
+ * As of 2.0.0, please use {@link pages.backStack.navigateBack pages.backStack.navigateBack(): Promise\<void\>} instead.
5009
5014
  *
5010
5015
  * Navigates back in the Teams client.
5011
5016
  * See registerBackButtonHandler for more information on when it's appropriate to use this method.
@@ -5016,7 +5021,7 @@ export function navigateBack(onComplete?: (status: boolean, reason?: string) =>
5016
5021
 
5017
5022
  /**
5018
5023
  * @deprecated
5019
- * As of 2.0.0-beta.1, please use {@link pages.config} namespace instead.
5024
+ * As of 2.0.0, please use {@link pages.config} namespace instead.
5020
5025
  *
5021
5026
  * Namespace to interact with the settings-specific part of the SDK.
5022
5027
  * This object is usable only on the settings frame.
@@ -5024,35 +5029,35 @@ export function navigateBack(onComplete?: (status: boolean, reason?: string) =>
5024
5029
  export namespace settings {
5025
5030
  /**
5026
5031
  * @deprecated
5027
- * As of 2.0.0-beta.1, please use {@link pages.config.Config} instead.
5032
+ * As of 2.0.0, please use {@link pages.config.Config} instead.
5028
5033
  * @remarks
5029
5034
  * Renamed to config in pages.Config
5030
5035
  */
5031
5036
  export import Settings = pages.InstanceConfig;
5032
5037
  /**
5033
5038
  * @deprecated
5034
- * As of 2.0.0-beta.1, please use {@link pages.config.SaveEvent} instead.
5039
+ * As of 2.0.0, please use {@link pages.config.SaveEvent} instead.
5035
5040
  * @remarks
5036
5041
  * See pages.SaveEvent
5037
5042
  */
5038
5043
  export import SaveEvent = pages.config.SaveEvent;
5039
5044
  /**
5040
5045
  * @deprecated
5041
- * As of 2.0.0-beta.1, please use {@link pages.config.RemoveEvent} instead.
5046
+ * As of 2.0.0, please use {@link pages.config.RemoveEvent} instead.
5042
5047
  * @remarks
5043
5048
  * See pages.RemoveEvent
5044
5049
  */
5045
5050
  export import RemoveEvent = pages.config.RemoveEvent;
5046
5051
  /**
5047
5052
  * @deprecated
5048
- * As of 2.0.0-beta.1, please use {@link pages.config.SaveParameters} instead.
5053
+ * As of 2.0.0, please use {@link pages.config.SaveParameters} instead.
5049
5054
  * @remarks
5050
5055
  * See pages.SaveParameters
5051
5056
  */
5052
5057
  export import SaveParameters = pages.config.SaveParameters;
5053
5058
  /**
5054
5059
  * @deprecated
5055
- * As of 2.0.0-beta.1, please use {@link pages.config.setValidityState pages.config.setValidityState(validityState: boolean): void} instead.
5060
+ * As of 2.0.0, please use {@link pages.config.setValidityState pages.config.setValidityState(validityState: boolean): void} instead.
5056
5061
  *
5057
5062
  * Sets the validity state for the settings.
5058
5063
  * The initial value is false, so the user cannot save the settings until this is called with true.
@@ -5062,7 +5067,7 @@ export namespace settings {
5062
5067
  function setValidityState(validityState: boolean): void;
5063
5068
  /**
5064
5069
  * @deprecated
5065
- * As of 2.0.0-beta.1, please use {@link pages.config.getConfig pages.config.getConfig(): Promise\<Config\>} instead.
5070
+ * As of 2.0.0, please use {@link pages.config.getConfig pages.config.getConfig(): Promise\<Config\>} instead.
5066
5071
  *
5067
5072
  * Gets the settings for the current instance.
5068
5073
  *
@@ -5071,7 +5076,7 @@ export namespace settings {
5071
5076
  function getSettings(callback: (instanceSettings: Settings) => void): void;
5072
5077
  /**
5073
5078
  * @deprecated
5074
- * As of 2.0.0-beta.1, please use {@link pages.config.setConfig pages.config.setConfig(instanceSettings: Config): Promise\<void\>} instead.
5079
+ * As of 2.0.0, please use {@link pages.config.setConfig pages.config.setConfig(instanceSettings: Config): Promise\<void\>} instead.
5075
5080
  *
5076
5081
  * Sets the settings for the current instance.
5077
5082
  * This is an asynchronous operation; calls to getSettings are not guaranteed to reflect the changed state.
@@ -5081,7 +5086,7 @@ export namespace settings {
5081
5086
  function setSettings(instanceSettings: Settings, onComplete?: (status: boolean, reason?: string) => void): void;
5082
5087
  /**
5083
5088
  * @deprecated
5084
- * As of 2.0.0-beta.1, please use {@link pages.config.registerOnSaveHandler pages.config.registerOnSaveHandler(handler: (evt: SaveEvent) => void): void} instead.
5089
+ * As of 2.0.0, please use {@link pages.config.registerOnSaveHandler pages.config.registerOnSaveHandler(handler: (evt: SaveEvent) => void): void} instead.
5085
5090
  *
5086
5091
  * Registers a handler for when the user attempts to save the settings. This handler should be used
5087
5092
  * to create or update the underlying resource powering the content.
@@ -5093,7 +5098,7 @@ export namespace settings {
5093
5098
  function registerOnSaveHandler(handler: (evt: SaveEvent) => void): void;
5094
5099
  /**
5095
5100
  * @deprecated
5096
- * As of 2.0.0-beta.1, please use {@link pages.config.registerOnRemoveHandler pages.config.registerOnRemoveHandler(handler: (evt: RemoveEvent) => void): void} instead.
5101
+ * As of 2.0.0, please use {@link pages.config.registerOnRemoveHandler pages.config.registerOnRemoveHandler(handler: (evt: RemoveEvent) => void): void} instead.
5097
5102
  *
5098
5103
  * Registers a handler for user attempts to remove content. This handler should be used
5099
5104
  * to remove the underlying resource powering the content.
@@ -5107,7 +5112,7 @@ export namespace settings {
5107
5112
 
5108
5113
  /**
5109
5114
  * @deprecated
5110
- * As of 2.0.0-beta.1, please use {@link dialog} namespace instead.
5115
+ * As of 2.0.0, please use {@link dialog} namespace instead.
5111
5116
  *
5112
5117
  * Namespace to interact with the task module-specific part of the SDK.
5113
5118
  * This object is usable only on the content frame.
@@ -5116,7 +5121,7 @@ export namespace settings {
5116
5121
  export namespace tasks {
5117
5122
  /**
5118
5123
  * @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
5124
+ * As of 2.0.0, please use {@link dialog.open(urlDialogInfo: UrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): PostMessageChannel} for url based dialogs
5120
5125
  * and {@link dialog.bot.open(botUrlDialogInfo: BotUrlDialogInfo, submitHandler?: DialogSubmitHandler, messageFromChildHandler?: PostMessageChannel): PostMessageChannel} for bot based dialogs.
5121
5126
  *
5122
5127
  * Allows an app to open the task module.
@@ -5127,7 +5132,7 @@ export namespace tasks {
5127
5132
  function startTask(taskInfo: TaskInfo, submitHandler?: (err: string, result: string | object) => void): IAppWindow;
5128
5133
  /**
5129
5134
  * @deprecated
5130
- * As of 2.0.0-beta.4, please use {@link dialog.update.resize dialog.update.resize(dimensions: DialogSize): void} instead.
5135
+ * As of 2.0.0, please use {@link dialog.update.resize dialog.update.resize(dimensions: DialogSize): void} instead.
5131
5136
  *
5132
5137
  * Update height/width task info properties.
5133
5138
  *
@@ -5136,7 +5141,7 @@ export namespace tasks {
5136
5141
  function updateTask(taskInfo: TaskInfo): void;
5137
5142
  /**
5138
5143
  * @deprecated
5139
- * As of 2.0.0-beta.1, please use {@link dialog.submit dialog.submit(result?: string | object, appIds?: string | string[]): void} instead.
5144
+ * As of 2.0.0, please use {@link dialog.submit dialog.submit(result?: string | object, appIds?: string | string[]): void} instead.
5140
5145
  *
5141
5146
  * Submit the task module.
5142
5147
  *