Type Method


Terminate the authentication session for a Hotspot network.


class func logoff(_ network: NEHotspotNetwork) -> Bool



A NEHotspotNetwork corresponding to the currently associated Wi-Fi network.

Return Value

true if the logoff command was successfully queued, false otherwise.


The application invokes this method when it wants to log off from the current network. Invoking this method causes an NEHotspotHelperCommand of type NEHotspotHelperCommandType.logoff to be issued to the application's 'handler' block, which is registered with the system by calling NEHotspotHelper registerWithOptions:queue:handler.

The network parameter must correspond to the currently associated Wi-Fi network i.e. it must have come from the network property of the NEHotspotHelperCommand or from the supportedInterfaces method.

Beta Software

This documentation contains preliminary information about an API or technology in development. This information is subject to change, and software implemented according to this documentation should be tested with final operating system software.

Learn more about using Apple's beta software