Skip to main content
HotspotAuthenticationContext.TryGetAuthenticationContext | tryGetAuthenticationContext method

Gets the context of an authentication attempt.

Note  

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

For permission to use this API, please reach out to Network Operators API Permissions.

For technical help with this API, please reach out to Network Operators API Help

 

Syntax


var context;
var result = Windows.Networking.NetworkOperators.HotspotAuthenticationContext.tryGetAuthenticationContext(evenToken, context);

public static bool TryGetAuthenticationContext(
  string evenToken, 
  out HotspotAuthenticationContext context
)

Public Shared Function TryGetAuthenticationContext(
  evenToken As String,  
  <OutAttribute> ByRef context As HotspotAuthenticationContext 
) As Boolean

public:
static bool TryGetAuthenticationContext(
  String^ evenToken, 
  [OutAttribute] HotspotAuthenticationContext^ context
)

Parameters

evenToken

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

The event token retrieved from the network operator hotspot authentication event. The token is a GUID in string format.

context (out parameter)

Type: HotspotAuthenticationContext

The network operator hotspot authentication context.

Return value

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

If true, the authentication context was retrieved. The authentication context can only be retrieved if the calling application matches the application ID specified in the hotspot profile of the underlying WLAN connection and if the authentication hasn’t be completed by the corresponding context already or timed out.

Requirements (Windows 10 device family)

Device family

Universal, introduced version 10.0.10240.0 [for Xbox, see UWP features that aren't yet supported on Xbox]

API contract

Windows.Foundation.UniversalApiContract, introduced version 1.0

Namespace

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

Metadata

Windows.Foundation.UniversalApiContract.winmd

Requirements (Windows 8.x and Windows Phone 8.x)

Minimum supported client

Windows 8

Minimum supported server

Windows Server 2012

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