Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Deprecated pages.NavigateCrossDomain and updated typedocs #2017

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Deprecated pages.NavigateCrossDomain and updated typedocs #2017

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
b9b7508
deprecated pages.NavigateCrossDomain and comments
vikramtha Nov 1, 2023
3ae97ab
Change files
vikramtha Nov 1, 2023
2daa83a
Merge branch 'main' into vikramtha/deprecateNavigateCrossDomain
AE-MS Nov 1, 2023
cbcf4f5
Update @microsoft-teams-js-142eccf1-7044-4c9b-b363-1b7d828c2184.json
AE-MS Nov 1, 2023
78647cb
Merge branch 'main' into vikramtha/deprecateNavigateCrossDomain
KangxuanYe Nov 22, 2023
5789692
Update change/@microsoft-teams-js-142eccf1-7044-4c9b-b363-1b7d828c218…
vikramtha Jan 29, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 7 additions & 0 deletions change/@microsoft-teams-js-142eccf1-7044-4c9b-b363-1b7d828c2184.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"type": "none",
"comment": "deprecated pages.NavigateCrossDomain and comments",
"packageName": "@microsoft/teams-js",
"email": "vikramtha@microsoft.com",
"dependentChangeType": "none"
}
2 changes: 1 addition & 1 deletion packages/teams-js/src/public/navigation.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@ export function navigateToTab(tabInstance: TabInstance, onComplete?: onCompleteH

/**
* @deprecated
* As of 2.0.0, please use {@link pages.navigateCrossDomain pages.navigateCrossDomain(url: string): Promise\<void\>} instead.
* As of 2.0.0, this API is no longer needed. Please remove any calls to it.
Copy link
Contributor

@AE-MS AE-MS Nov 1, 2023 •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As of 2.0.0, this API is no longer needed. Please remove any calls to it.

What should developers who read this do instead?

Can you delete the text below (or updated it to somehow reflect that it's not necessary to know this anymore?) since developers shouldn't use it anymore?

*
* Navigates the frame to a new cross-domain URL. The domain of this URL must match at least one of the
* valid domains specified in the validDomains block of the manifest; otherwise, an exception will be
Expand Down
3 changes: 3 additions & 0 deletions packages/teams-js/src/public/pages.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,6 +146,9 @@ export namespace pages {
}

/**
* @deprecated
* As of 2.0.0, this API is no longer needed. Please remove any calls to it.
*
* Navigates the frame to a new cross-domain URL. The domain of this URL must match at least one of the
* valid domains specified in the validDomains block of the manifest; otherwise, an exception will be
* thrown. This function needs to be used only when navigating the frame to a URL in a different domain
Expand Down