HotspotAuthenticationContext HotspotAuthenticationContext HotspotAuthenticationContext HotspotAuthenticationContext HotspotAuthenticationContext Class

Definition

Provides the authentication context that contains details of the current authentication attempt and provides methods to perform the authentication.

Note

This functionality is only available to mobile operator apps and UWP apps given privileged access by mobile network operators.

If you want to use this API and publish your app to the Store, you will need special approval. For more information, see the Special and restricted capabilities section under App capability declarations.

public : sealed class HotspotAuthenticationContext : IHotspotAuthenticationContext, IHotspotAuthenticationContext2
struct winrt::Windows::Networking::NetworkOperators::HotspotAuthenticationContext : IHotspotAuthenticationContext, IHotspotAuthenticationContext2
public sealed class HotspotAuthenticationContext : IHotspotAuthenticationContext, IHotspotAuthenticationContext2
Public NotInheritable Class HotspotAuthenticationContext Implements IHotspotAuthenticationContext, IHotspotAuthenticationContext2
// This class does not provide a public constructor.
Attributes
Windows 10 requirements
Device family
Windows 10 (introduced v10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
API contract
Windows.Foundation.UniversalApiContract (introduced v1)
Capabilities
cellularDeviceControl cellularDeviceIdentity

Properties

AuthenticationUrl AuthenticationUrl AuthenticationUrl AuthenticationUrl AuthenticationUrl

Gets the HTTPS URL specified in the Wireless Internet Service Provider roaming (WISPr) redirect message.

Note

This functionality is only available to mobile operator apps and UWP apps given privileged access by mobile network operators.

If you want to use this API and publish your app to the Store, you will need special approval. For more information, see the Special and restricted capabilities section under App capability declarations.

Applications must determine whether to trust this URL for providing credentials.

NetworkAdapter NetworkAdapter NetworkAdapter NetworkAdapter NetworkAdapter

Gets the network interface that is connected to the WLAN access point of the hotspot.

Note

This functionality is only available to mobile operator apps and UWP apps given privileged access by mobile network operators.

If you want to use this API and publish your app to the Store, you will need special approval. For more information, see the Special and restricted capabilities section under App capability declarations.

RedirectMessageUrl RedirectMessageUrl RedirectMessageUrl RedirectMessageUrl RedirectMessageUrl

Gets the URL of the web page where the Wireless Internet Service Provider roaming (WISPr) redirect message was found.

Note

This functionality is only available to mobile operator apps and UWP apps given privileged access by mobile network operators.

If you want to use this API and publish your app to the Store, you will need special approval. For more information, see the Special and restricted capabilities section under App capability declarations.

RedirectMessageXml RedirectMessageXml RedirectMessageXml RedirectMessageXml RedirectMessageXml

Gets the XML blob of the Wireless Internet Service Provider roaming (WISPr) redirect message of the hotspot.

Note

This functionality is only available to mobile operator apps and UWP apps given privileged access by mobile network operators.

If you want to use this API and publish your app to the Store, you will need special approval. For more information, see the Special and restricted capabilities section under App capability declarations.

WirelessNetworkId WirelessNetworkId WirelessNetworkId WirelessNetworkId WirelessNetworkId

Gets the SSID of the WLAN access point of the hotspot.

Note

This functionality is only available to mobile operator apps and UWP apps given privileged access by mobile network operators.

If you want to use this API and publish your app to the Store, you will need special approval. For more information, see the Special and restricted capabilities section under App capability declarations.

Methods

AbortAuthentication(Boolean) AbortAuthentication(Boolean) AbortAuthentication(Boolean) AbortAuthentication(Boolean) AbortAuthentication(Boolean)

Aborts the current authentication attempt and disconnects the WLAN interface from the hotspot.

Note

This functionality is only available to mobile operator apps and UWP apps given privileged access by mobile network operators.

If you want to use this API and publish your app to the Store, you will need special approval. For more information, see the Special and restricted capabilities section under App capability declarations.

IssueCredentials(String, String, String, Boolean) IssueCredentials(String, String, String, Boolean) IssueCredentials(String, String, String, Boolean) IssueCredentials(String, String, String, Boolean) IssueCredentials(String, String, String, Boolean)

Provides credentials to Windows for hotspot authentication

Note

This functionality is only available to mobile operator apps and UWP apps given privileged access by mobile network operators.

If you want to use this API and publish your app to the Store, you will need special approval. For more information, see the Special and restricted capabilities section under App capability declarations.

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

IssueCredentialsAsync(String, String, String, Boolean) IssueCredentialsAsync(String, String, String, Boolean) IssueCredentialsAsync(String, String, String, Boolean) IssueCredentialsAsync(String, String, String, Boolean) IssueCredentialsAsync(String, String, String, Boolean)

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 UWP apps given privileged access by mobile network operators.

If you want to use this API and publish your app to the Store, you will need special approval. For more information, see the Special and restricted capabilities section under App capability declarations.

SkipAuthentication() SkipAuthentication() SkipAuthentication() SkipAuthentication() SkipAuthentication()

Skips Wireless Internet Service Provider roaming (WISPr) Windows authentication.

Note

This functionality is only available to mobile operator apps and UWP apps given privileged access by mobile network operators.

If you want to use this API and publish your app to the Store, you will need special approval. For more information, see the Special and restricted capabilities section under App capability declarations.

TriggerAttentionRequired(String, String) TriggerAttentionRequired(String, String) TriggerAttentionRequired(String, String) TriggerAttentionRequired(String, String) TriggerAttentionRequired(String, String)

Called by a background task handler to launch the foreground application when there is an authentication attempt to complete.

Note

This functionality is only available to mobile operator apps and UWP apps given privileged access by mobile network operators.

If you want to use this API and publish your app to the Store, you will need special approval. For more information, see the Special and restricted capabilities section under App capability declarations.

Windows will launch the specified application.

TryGetAuthenticationContext(String, HotspotAuthenticationContext) TryGetAuthenticationContext(String, HotspotAuthenticationContext) TryGetAuthenticationContext(String, HotspotAuthenticationContext) TryGetAuthenticationContext(String, HotspotAuthenticationContext) TryGetAuthenticationContext(String, HotspotAuthenticationContext)

Gets the context of an authentication attempt.

Note

This functionality is only available to mobile operator apps and UWP apps given privileged access by mobile network operators.

If you want to use this API and publish your app to the Store, you will need special approval. For more information, see the Special and restricted capabilities section under App capability declarations.

See Also