Constructor OAuthUserConfiguration
OAuthUserConfiguration(Uri, String, Uri, CultureInfo, TimeSpan, TimeSpan, TimeSpan, Boolean, UserInterfaceStyle, Boolean)
Initializes a new instance of the OAuthUserConfiguration class with the specified parameters.
Declaration
public OAuthUserConfiguration(Uri portalUrl, string clientId, Uri redirectUrl, CultureInfo culture = null, TimeSpan refreshTokenExpirationInterval = default(TimeSpan), TimeSpan refreshTokenExchangeInterval = default(TimeSpan), TimeSpan federatedTokenExpirationInterval = default(TimeSpan), bool showCancelButton = true, UserInterfaceStyle userInterfaceStyle = UserInterfaceStyle.Unspecified, bool preferPrivateWebBrowserSession = false)Parameters
| Type | Name | Description |
|---|---|---|
| System.Uri | portalUrl | The URL of the portal to authenticate with. |
| System.String | clientId | A unique identifier associated with an application registered with the portal that assists with client/server OAuth authentication. |
| System.Uri | redirectUrl | The URL that the OAuth login page redirects to when authentication completes. |
| System.Globalization.CultureInfo | culture | The OAuth login page is displayed in the language specified by the given culture code. If not specified, System.Globalization.CultureInfo.CurrentUICulture will be used. |
| System.TimeSpan | refreshTokenExpirationInterval | The requested expiration interval for the refreshToken generated by the OAuth request. Set this to System.TimeSpan.MaxValue for getting the maximum refresh token supported by the portal (ninety days). The max interval can be overridden by the portal administrator. |
| System.TimeSpan | refreshTokenExchangeInterval | The requested exchange interval for the OAuth refresh token. Use this to exchange
a refresh token before it expires. This will limit the number of times a user will have to login because
of expiring tokens. If unspecified or set to 0, default exchange interval of 24 hours is used.
If the exchange interval is less than System.TimeSpan.Zero, then the refresh token will never be exchanged
and will eventually expire, causing the user to have to log in again.
To have any effect, this should be set to a value less than the |
| System.TimeSpan | federatedTokenExpirationInterval | The requested expiration interval for federated tokens generated using the OAuth credential. |
| System.Boolean | showCancelButton | A value indicating whether to show "Cancel" button on the OAuth login page. |
| UserInterfaceStyle | userInterfaceStyle | Constants indicating the interface style for the OAuth login page. |
| System.Boolean | preferPrivateWebBrowserSession | A value indicating whether the OAuth login session should ask the browser for a private authentication session. |
Applies to
Platforms and versions
| Target | Versions |
|---|---|
| .NET Standard 2.0 | 200.5 - 200.6 |
| .NET | 200.5 - 200.6 |
| .NET Windows | 200.5 - 200.6 |
| .NET Android | 200.5 - 200.6 |
| .NET iOS | 200.5 - 200.6 |
| .NET Framework | 200.5 - 200.6 |
| UWP | 200.5 - 200.6 |