---
title: "register(options:queue:handler:)"
framework: networkextension
role: symbol
role_heading: Type Method
path: "networkextension/nehotspothelper/register(options:queue:handler:)"
---

# register(options:queue:handler:)

Register the application as a Hotspot Helper.

## Declaration

```swift
class func register(options: [String : NSObject]? = nil, queue: dispatch_queue_t, handler: @escaping NEHotspotHelperHandler) -> Bool
```

## Parameters

- `options`: If not nil, a doc://com.apple.documentation/documentation/Foundation/NSDictionary containing kNEHotspotHelperOption* keys (currently just kNEHotspotHelperOptionDisplayName).
- `queue`: The doc://com.apple.documentation/documentation/Dispatch/dispatch_queue_t to invoke the handle block on.
- `handler`: The NEHotspotHelperHandler block to execute to process helper commands.

## Return Value

Return Value true if the registration was successful, false otherwise

## Discussion

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 false being returned. warning: The application’s Info.plist must include a UIBackgroundModes array containing network-authentication. warning: The application must set com.apple.developer.networking.HotspotHelper as one of its entitlements. The value of the entitlement is a boolean set to true.

## See Also

### Registering a hotspot helper

- [kNEHotspotHelperOptionDisplayName](networkextension/knehotspothelperoptiondisplayname.md)
- [NEHotspotHelperHandler](networkextension/nehotspothelperhandler.md)