diff --git a/docs-source/documentation/migration/v3.md b/docs-source/documentation/migration/v3.md index b1a7cc83..e30a40c1 100644 --- a/docs-source/documentation/migration/v3.md +++ b/docs-source/documentation/migration/v3.md @@ -8,11 +8,11 @@ Everyone should migrate to v3. All previous versions are deprecated. For some developers, this upgrade will not be breaking. If you do not see compiler errors when taking a dependency on v3 then you should skip to the section Other Considerations. -### Breaking Changes +## Breaking Changes There are a number of potential breaking changes in this release depending on how you use the library and what .NET SDK you use. -#### Minimum Runtime +### Minimum Runtime v3 of this library targets only .NET Standard 2.0 and drops support for .NET Standard 1.4 and .NET Framework 4.5.2. @@ -22,23 +22,23 @@ This only affects WPF, WinForms and UWP. Android and iOS are not affected. If yo - WinForms to .NET Framework 4.6.1 - UWP to uap10.0.16299 (Windows 10 Fall Creators Update) -#### IAuth0Client Interface +### IAuth0Client Interface If you are implementing the `IAuth0Client` interface you will need to reflect the latest changes to the signature. Each Async method now takes an optional `CancellationToken`. Also, method overloads for `LogoutAsync` and `RefreshTokenAsync` were combined. If you use the `Auth0Client` class directly you will not need to make any changes. The compiler will be able to utilize the defaults provided for the new parameters. -#### PlatformWebView Class Removal +### PlatformWebView Class Removal This class is now removed across all platforms. To use default Browser behavior simply leave the `Browser` property of `Auth0ClientOptions` uninitialized. -### Other Considerations +## Other Considerations -#### Android +### Android It is now recommended you pass `this` as the second argument to the `Auth0Client` constructor when creating it from your Activity. This allows `Auth0Client` to automatically read the `IntentFilter` on your Activity and determine the correct callback uri to use. Additionally it allows the `ChromeCustomTab` and `SystemBrowser` integrations to avoid needing to request the `NewTask` `ActivityFlag`. -#### Windows +### Windows The Microsoft Edge browser is now the default for WPF, WinForms and UWP applications. Where it is not available it will fall back to Internet Explorer. This resolves some problems with some IDPs where large warnings about Interner Explorer not being supported appear (such as GitHub.com). @@ -60,11 +60,11 @@ var options = new Auth0ClientOptions { } ``` -#### Scopes +### Scopes Request scopes now includes `email` by default. Additionally while you can change the `Scope` property on the `Auth0ClientOptions` all endpoints will always be called with `openid` present in order to ensure OpenID Connect compliance. -#### ClientSecret Deprecation +### ClientSecret Deprecation The `ClientSecret` property of `Auth0ClientOptions` has been deprecated and will be removed in a future release. It is highly inadvisable to use Client Secrets inside non-confidential clients. The purpose of this library is to target desktop and mobile applications which by their nature should be considered non-confidential.