HotspotAuthenticationContext Class
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Provides the authentication context that contains details of the current authentication attempt and provides methods to perform the authentication.
Note
This functionality is available only 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 Microsoft Store, then you'll need special approval. For more information, see the Restricted capabilities section in the App capability declarations topic.
public ref class HotspotAuthenticationContext sealed/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 65536)]
/// [Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
class HotspotAuthenticationContext final[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 65536)]
[Windows.Foundation.Metadata.Threading(Windows.Foundation.Metadata.ThreadingModel.Both)]
public sealed class HotspotAuthenticationContextPublic NotInheritable Class HotspotAuthenticationContext- Inheritance
- Attributes
Windows requirements
| Device family |
Windows 10 (introduced in 10.0.10240.0 - for Xbox, see UWP features that aren't yet supported on Xbox)
|
| API contract |
Windows.Foundation.UniversalApiContract (introduced in v1.0)
|
| App capabilities |
cellularDeviceControl
cellularDeviceIdentity
|
Properties
| AuthenticationUrl |
Gets the HTTPS URL specified in the Wireless Internet Service Provider roaming (WISPr) redirect message. Note This functionality is available only 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 Microsoft Store, then you'll need special approval. For more information, see the Restricted capabilities section in the App capability declarations topic. Applications must determine whether to trust this URL for providing credentials. |
| NetworkAdapter |
Gets the network interface that is connected to the WLAN access point of the hotspot. Note This functionality is available only 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 Microsoft Store, then you'll need special approval. For more information, see the Restricted capabilities section in the App capability declarations topic. |
| RedirectMessageUrl |
Gets the URL of the web page where the Wireless Internet Service Provider roaming (WISPr) redirect message was found. Note This functionality is available only 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 Microsoft Store, then you'll need special approval. For more information, see the Restricted capabilities section in the App capability declarations topic. |
| RedirectMessageXml |
Gets the XML blob of the Wireless Internet Service Provider roaming (WISPr) redirect message of the hotspot. Note This functionality is available only 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 Microsoft Store, then you'll need special approval. For more information, see the Restricted capabilities section in the App capability declarations topic. |
| WirelessNetworkId |
Gets the SSID of the WLAN access point of the hotspot. Note This functionality is available only 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 Microsoft Store, then you'll need special approval. For more information, see the Restricted capabilities section in the App capability declarations topic. |
Methods
| AbortAuthentication(Boolean) |
Aborts the current authentication attempt and disconnects the WLAN interface from the hotspot. Note This functionality is available only 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 Microsoft Store, then you'll need special approval. For more information, see the Restricted capabilities section in the App capability declarations topic. |
| IssueCredentials(String, String, String, Boolean) |
Provides credentials to Windows for hotspot authentication Note This functionality is available only 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 Microsoft Store, then you'll need special approval. For more information, see the Restricted capabilities section in the App capability declarations topic. 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) |
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 available only 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 Microsoft Store, then you'll need special approval. For more information, see the Restricted capabilities section in the App capability declarations topic. |
| SkipAuthentication() |
Skips Wireless Internet Service Provider roaming (WISPr) Windows authentication. Note This functionality is available only 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 Microsoft Store, then you'll need special approval. For more information, see the Restricted capabilities section in the App capability declarations topic. |
| 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 available only 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 Microsoft Store, then you'll need special approval. For more information, see the Restricted capabilities section in the App capability declarations topic. Windows will launch the specified application. |
| TryGetAuthenticationContext(String, HotspotAuthenticationContext) |
Gets the context of an authentication attempt. Note This functionality is available only 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 Microsoft Store, then you'll need special approval. For more information, see the Restricted capabilities section in the App capability declarations topic. |