Method GenerateCredentialAsync
GenerateCredentialAsync(Uri, String, String, GenerateTokenOptions)
Generates a token credential object asynchronously. You need to provide the service URI, the username and the password. This is a helper method typically called by the UI challenging the user.
Declaration
public Task<TokenCredential> GenerateCredentialAsync(Uri serviceUri, string userName, string password, GenerateTokenOptions generateTokenOptions = null)Parameters
| Type | Name | Description |
|---|---|---|
| Uri | serviceUri | The service Uri. |
| String | userName | The user name. |
| String | password | The password. |
| GenerateTokenOptions | generateTokenOptions | The optional infos concerning the token to generate (referer, credentials). |
Returns
| Type | Description |
|---|---|
| Task<TokenCredential> | The task object representing the asynchronous generate credential operation. The value of the task result is a TokenCredential object. |
Exceptions
| Type | Condition |
|---|---|
| ArgumentNullException | serviceUri |
Applies to
Platforms and versions
| Target | Versions |
|---|---|
| .NET Standard 2.0 | 100.9.0, 100.8.0, 100.7.0, 100.6.0, 100.5.0, 100.4.0, 100.3.0 |
| .NET 6.0 | 100.13.0 |
| .NET 6.0 Windows | 100.13.0 |
| .NET Framework | 100.13.0, 100.12.0, 100.11.2, 100.11.0, 100.10.0, 100.9.0, 100.8.0, 100.7.0, 100.6.0, 100.5.0, 100.4.0, 100.3.0, 100.2.1, 100.1.0, 100.0.0 |
| .NET 5 | 100.12.0, 100.10.0 |
| .NET Core | 100.12.0, 100.11.2, 100.11.0, 100.10.0, 100.9.0, 100.8.0, 100.7.0 |
| Xamarin.Android | 100.8.0, 100.7.0, 100.6.0, 100.5.0, 100.4.0, 100.3.0, 100.2.1, 100.1.0, 100.0.0 |
| Xamarin.iOS | 100.13.0, 100.12.0, 100.11.2, 100.11.0, 100.10.0, 100.9.0, 100.8.0, 100.7.0, 100.6.0, 100.5.0, 100.4.0, 100.3.0, 100.2.1, 100.1.0, 100.0.0 |
| UWP | 100.9.0, 100.8.0, 100.7.0, 100.6.0, 100.5.0, 100.4.0, 100.3.0, 100.2.1, 100.1.0, 100.0.0 |
GenerateCredentialAsync(Uri, GenerateTokenOptions)
Generates a token credential object asynchronously. You need to provide the service URL. This is a helper method typically called by the UI challenging the user.
Declaration
public Task<TokenCredential> GenerateCredentialAsync(Uri serviceUri, GenerateTokenOptions generateTokenOptions = null)Parameters
| Type | Name | Description |
|---|---|---|
| Uri | serviceUri | The URL. |
| GenerateTokenOptions | generateTokenOptions | The optional infos concerning the token to generate (referer, credentials). |
Returns
| Type | Description |
|---|---|
| Task<TokenCredential> | The task object representing the asynchronous generate credential operation. The value of the task result is a TokenCredential object. |
Exceptions
| Type | Condition |
|---|---|
| ArgumentNullException | serviceUri |
See Also
Applies to
Platforms and versions
| Target | Versions |
|---|---|
| .NET Standard 2.0 | 100.9.0, 100.8.0, 100.7.0, 100.6.0, 100.5.0, 100.4.0, 100.3.0 |
| .NET 6.0 | 100.13.0 |
| .NET 6.0 Windows | 100.13.0 |
| .NET Framework | 100.13.0, 100.12.0, 100.11.2, 100.11.0, 100.10.0, 100.9.0, 100.8.0, 100.7.0, 100.6.0, 100.5.0, 100.4.0, 100.3.0, 100.2.1, 100.1.0, 100.0.0 |
| .NET 5 | 100.12.0, 100.10.0 |
| .NET Core | 100.12.0, 100.11.2, 100.11.0, 100.10.0, 100.9.0, 100.8.0, 100.7.0 |
| Xamarin.Android | 100.8.0, 100.7.0, 100.6.0, 100.5.0, 100.4.0, 100.3.0, 100.2.1, 100.1.0, 100.0.0 |
| Xamarin.iOS | 100.13.0, 100.12.0, 100.11.2, 100.11.0, 100.10.0, 100.9.0, 100.8.0, 100.7.0, 100.6.0, 100.5.0, 100.4.0, 100.3.0, 100.2.1, 100.1.0, 100.0.0 |
| UWP | 100.9.0, 100.8.0, 100.7.0, 100.6.0, 100.5.0, 100.4.0, 100.3.0, 100.2.1, 100.1.0, 100.0.0 |