Type Method

registerWithOptions:queue:handler:

Register the application as a Hotspot Helper.

Declaration

+ (BOOL)registerWithOptions:(NSDictionary<NSString *,NSObject *> *)options queue:(dispatch_queue_t)queue handler:(NEHotspotHelperHandler)handler;

Parameters

options

If not nil, a NSDictionary containing kNEHotspotHelperOption* keys (currently just kNEHotspotHelperOptionDisplayName).

queue

The dispatch_queue_t to invoke the handle block on.

handler

The NEHotspotHelperHandler block to execute to process helper commands.

Return Value

YES if the registration was successful, NO otherwise

Discussion

Once this API is invoked successfully, the application becomes eligible to be launched in the background and participate in various hotspot related functions.

This method should be called once when the application starts up. Invoking it again will have no effect and result in NO being returned.

See Also

Registering a Hotspot Helper

kNEHotspotHelperOptionDisplayName

The string displayed in Wi-Fi Settings for a network handled by the application.

NEHotspotHelperHandler

The type definition for the Hotspot Helper's command handler block.

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