Skip to main content
HotspotAuthenticationContext.IssueCredentialsAsync | issueCredentialsAsync method

Applies to Windows and Windows Phone

Asynchronously provides credentials to Windows for hotspot authentication Windows does not cache these credentials and another authentication event will be raised when the system connects to the same hotspot again.

It is an asynchronous version of IssueCredentials. It takes the same parameters, but the asynchronous operation only completes when the authentication is completed. In contrast, the IssueCredentials API returns as soon as the authentication is started. On completion of this method, the results object may be examined to check the status of the authentication attempt.

Note  This functionality is only available to mobile operator apps and Windows Store apps given privileged access by mobile network operators. For more information, see Mobile Broadband: Windows Store device apps.

Syntax


hotspotAuthenticationContext.issueCredentialsAsync(userName, password, extraParameters, markAsManualConnectOnFailure).done( /* Your success and error handlers */ );

public IAsyncOperation<HotspotCredentialsAuthenticationResult> IssueCredentialsAsync(
  string userName, 
  string password, 
  string extraParameters, 
  bool markAsManualConnectOnFailure
)

Public Function IssueCredentialsAsync(
  userName As String,  
  password As String,  
  extraParameters As String,  
  markAsManualConnectOnFailure As Boolean 
) As IAsyncOperation(Of HotspotCredentialsAuthenticationResult)

public:
IAsyncOperation<HotspotCredentialsAuthenticationResult>^ IssueCredentialsAsync(
  String^ userName, 
  String^ password, 
  String^ extraParameters, 
  bool markAsManualConnectOnFailure
)

Parameters

userName

Type: String [JavaScript] | System.String [.NET] | Platform::String [C++]

The UserName parameter of the Wireless Internet Service Provider roaming (WISPr) authentication protocol. IssueCredentials performs URL encoding before submitting the value to the server. If this string is empty, the corresponding authentication parameter is skipped.

password

Type: String [JavaScript] | System.String [.NET] | Platform::String [C++]

The Password parameter of the WISPr authentication protocol. IssueCredentials performs URL encoding before submitting the value to the server. If this string is empty, the corresponding authentication parameter is skipped.

extraParameters

Type: String [JavaScript] | System.String [.NET] | Platform::String [C++]

Additional parameters to be appended to the authentication string. IssueCredentials appends this parameter after an "&" character to the HTTP POST string as is without any encoding. This can be used to add multiple parameters. The default for this parameter is an empty string.

markAsManualConnectOnFailure

Type: Boolean [JavaScript] | System.Boolean [.NET] | Platform::Boolean [C++]

If true, an application permanently disables the auto-connect property on a connection. If authentication fails, the connection will be disconnected and not retried in the current user session. Otherwise, false.

Return value

Type: IAsyncOperation<HotspotCredentialsAuthenticationResult>

Results of the Hotspot authentication request.

Requirements

Minimum supported client

Windows 8.1

Minimum supported server

Windows Server 2012 R2

Minimum supported phone

Windows Phone 8.1 [Windows Runtime apps only]

Namespace

Windows.Networking.NetworkOperators
Windows::Networking::NetworkOperators [C++]

Metadata

Windows.winmd

See also

HotspotAuthenticationContext