NEHotspotManager

class · iOS 26.0+ · SDK 27.1

final class NEHotspotManager

This file declares the NEHotspotManager API. The NEHotspotManager API is used to enable or disable NEHotspotEvaluationProvider and NEHotspotAuthenticationProvider. When enabled, the API allows the providers to participate in the process of joining Wi-Fi/Hotspot networks. The providers receive commands to be processed that allow them to participate in the Hotspot Network state machine. When a network is joined initially, the state machine enters the Evaluating state. In that state, each NEHotspotEvaluationProvider instance receives a command of type Evaluate. If one or more instances of NEHotspotEvaluationProvider indicates that it is able to handle the network, the one with the highest confidence level is chosen before entering the Authenticating state. As an optimization, the first instance to assert a high confidence wins and the state machine ignores the other instances. If no NEHotspotEvaluationProvider instances claims the network, the state machine enters the Authenticated state. In the Authenticating state, the NEHotspotAuthenticationProvider instance is given a command of type Authenticate. The instance is expected to perform whatever network processing is required to make the network available for general network traffic. If the authentication is successful, the instance indicates that with a Success result. The state machine enters the Authenticated state. On a network that has been authenticated by a NEHotspotAuthenticationProvider, the state machine enters the Maintaining state when the network is joined again, and also periodically while the system remains associated with the network. In the Maintaining state, the NEHotspotAuthenticationProvider instance is expected to perform whatever network operations are required to determine if the network is still able to carry general network traffic. If that is the case, the instance returns Success. If not, and authentication is again required, it returns AuthenticationRequired to cause the state machine to re-enter the Authenticating state. In the Authenticating state, if the NEHotspotAuthenticationProvider instance determines that it requires user interaction to proceed, the instance is expected to alert the user via UNUserNotificationCenter, then returns a result of UIRequired. The state machine enters the PresentingUI state. In the PresentingUI state, the NEHotspotAuthenticationProvider instance is given a command of type PresentUI. The instance continues to run in the background in PresentingUI state, and relies on its application to provide the required information collected from the user to perform the authentication. Once the authentication is completed successfully, NEHotspotAuthenticationProvider instance returns Success to enter the Authenticated state. NEHotspotEvaluationProvider may also receive a FilterScanList command at any time, in addition to an Evaluate command as described above. In its response, the NEHotspotEvaluationProvider indicates which of the networks in the scan list it can confidently handle. This API is part of NetworkExtension.framework. NEHotspotManager class declares a programmatic interface to enable or disable NEHotspotEvaluationProvider and NEHotspotAuthenticationProvider.

Members (14)

get safariDomains(): Array<string>

final var safariDomains: [String] { get set }

set safariDomains(value: Array<string>)

final var safariDomains: [String] { get set }

get evaluatedSSIDs(): Array<string>

final var evaluatedSSIDs: [String] { get set }

set evaluatedSSIDs(value: Array<string>)

final var evaluatedSSIDs: [String] { get set }

saveToPreferences(): Promise<void>

final func saveToPreferences() async throws

loadFromPreferences(): Promise<void>

final func loadFromPreferences() async throws

removeFromPreferences(): Promise<void>

final func removeFromPreferences() async throws

get evaluationProviderBundleIdentifier(): (string) | null

final var evaluationProviderBundleIdentifier: String? { get set }

set evaluationProviderBundleIdentifier(value: (string) | null)

final var evaluationProviderBundleIdentifier: String? { get set }

get authenticationProviderBundleIdentifier(): (string) | null

final var authenticationProviderBundleIdentifier: String? { get set }

set authenticationProviderBundleIdentifier(value: (string) | null)

final var authenticationProviderBundleIdentifier: String? { get set }

static get shared(): NEHotspotManager

static var shared: NEHotspotManager { get }

get isEnabled(): boolean

final var isEnabled: Bool { get set }

set isEnabled(value: boolean)

final var isEnabled: Bool { get set }

All NetworkExtension types →