Tasks

Other Methods

•   delegate

  Assign a delegate to receive NAPlatformDelegate messages.

  property
• + isInitialized

  Determine if NAPlatform has been initialized yet

• + setLogLevel:classes:logger:

  Set logging level for the SDK and provide a callback function to receive log messages NALOGLEVEL_DEBUG is only available in debug builds of the SDK.

• + initializeWithApplicationId:packageName:delegate:

  Initialize NAPlatform with your developer application ID and delegate. You must initialize the platform before you can access [NAPlatform sharedNAPlatform].

• + sharedNAPlatform

  NAPlatform is a singleton and this is the only way to access the instance.

• – registerBeaconIds:

  Register iBeacon IDs that this application is compatible with. Register additional iBeacon IDs before you begin scanning to ensure that you will detect devices with those IDs. If you only need to scan for devices matching your registered application ID, you don’t need to call this function.

• – allowBackground:

  Enable/disable background scanning. This allows you to control if the NewAer SDK will process events when your application is in the background. If you disable background scanning, your application will use less power.

• – enableRanging:

  Enable support for ranging. This will allow you to receive device updates more frequently when you are scanning. When state = NO (default) you will receive a device update no more often than once every 30 seconds. When state = YES you will receive a device update as often as the hardware supports, typically around once a second.

• – includeRemoteDevices:

  Include remotely discovered devices. This method tells the SDK to use the NewAer Proximity Server to compare local observations made by each device running the SDK with others. Devices will be found even if they cannot always be seen directly. The NewAer Proximity server identifies shared observations, such as a Beacon, a WiFi access point, or another NewAer enabled device. Those shared observations are used to make indirect proximity connections.

Scanning

• – startScanWithDeviceTypes:

  Starts scanning for a specific scan family.

• – stopScanWithDeviceTypes:

  Stops scanning for specific device types.

Advertising

• – startAdvertisingWithDeviceTypes:name:

  Start advertising for the specified device types. The only device types that currently support advertising are NATYPE_NEWAER and NATYPE_BEACON (iOS only).

• – stopAdvertisingWithDeviceTypes:

  Stops advertising for specific device types. The [NAPlatformDelegate platformDidStopAdvertise:] delegate will be called if the advertise was stopped successfully.

Messaging

• – sendMessage:to:

  Queues a message to be sent to a device ID. The device ID need not be visible currently and may come into range in the future. The message send request does not timeout and only one message may be queued at a time. Calling this method a second time overwrites the first message. Only peer devices of scan type NATYPE_NEWAER can receive messages. When you stop scanning, all queued messages are discarded.

• – releaseDevice:

  Releases a device identified by deviceId from the scanning cache. Use this to get new peer info on the next scan.

Platform information

• – getMyDeviceId

  Gets the deviceId for this device for the corresponding NADeviceType

• + launchedWithLocation

  Indicates whether the application was launched as a result of a beacon based geofence. Call immediately after initializing NAPlatform.

• – handleWake

  This method is used to send a wakeup event to NAPlatform. This event may cause scanning or advertising to be restarted. This method is typically used to enable background scanning to occur when your application awakes due to an iOS background event such as: background refresh, server push, or regular location change. NAPlatform automatically handles iOS background events due to: bluetooth central/peripheral and significant location changes. Call this event from your app delegate for:

    UIApplication application:performFetchWithCompletionHandler:,
    UIApplication application:didReceiveRemoteNotification:fetchCompletionHandler:,
    or from your core location manager delegate for: CoreLocation locationManager:didUpdateLocations:
  

• – handleTerminate

  This method is used to ensure that the NewAer SDK is put into a known state when your application is killed by the user. You need to call this method from your AppDelegate applicationWillTerminate:(UIApplication *)application method. If you do not call this method, your app may not be correctly resurrected when encountering an iBeacon.

typedef enum {
  NALOGLEVEL_DEBUG = 0,
  NALOGLEVEL_INFO = 1,
  NALOGLEVEL_ERROR = 2
} NALogLevel;

  UIApplication application:performFetchWithCompletionHandler:,
  UIApplication application:didReceiveRemoteNotification:fetchCompletionHandler:,
  or from your core location manager delegate for: CoreLocation locationManager:didUpdateLocations: