NAPlatform (newaer-sdk-proximity API)

java.lang.Object
- com.newaer.sdk.proximity.NAPlatform

```
public abstract class NAPlatform
extends Object
```
This is the NewAer Proximity Platform. It contains methods for initializing the platform, getting the platform for a given context, enabling, starting and stopping scanning for various device types.
It also contains methods for getting and creating devices, rules, actions and plugins. However, we have provided static convenience methods, which are almost always shorter to type, especially if you don't already have a platform instance. We suggest you use those.
NewAer uses Semantic Versioning.

Field Summary

Fields
Modifier and Type	Field and Description
`static String`	`SDK_VERSION_CODE`
`static int`	`SDK_VERSION_MAJOR` The major version number of the platform.
`static int`	`SDK_VERSION_MINOR` The minor version number of the platform.
`static int`	`SDK_VERSION_PATCH` The patch number of the platform.

Constructor Summary

Constructors
Modifier Constructor and Description

protected NAPlatform()
Only subclasses may construct.

Constructors
Modifier	Constructor and Description
`protected`	`NAPlatform()` Only subclasses may construct.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`static void`	`destroy(Context context)` Shut down the platform, stopping all scans and dereferencing.
`abstract void`	`enablePrivateAnnounce(boolean announce)`
`static NAPlatform`	`get(Context context)` Returns an instance of the NewAer Platform.
`abstract List<NADevice>`	`getAllDevices()` Returns a collection of devices the platform has recently seen.
`abstract List<NADevice>`	`getAllDevicesByType(NADeviceType type)` Returns a collection of devices the platform has recently seen.
`abstract String`	`getAppId()`
`abstract NADevice`	`getDevice(String id)` Retrieves a device by it's id.
`abstract String`	`getFriendlyName()` Returns the friendly name for this device.
`abstract byte[]`	`getInfo()`
`abstract String`	`getNewAerId()` Returns a unique identifier which will be seen by others with scanning.
`abstract Set<NAScanType>`	`getPersistentScanTypes()` Returns an `EnumSet` of `NAScanType`s previously marked as persistent.
`abstract int`	`getScanInterval()`
`abstract long`	`getScanTime()`
`static String`	`getVersion()`
`abstract boolean`	`hasHardware(NADeviceType type)` Returns true if the device has hardware required for discovering a particular device type.
`static void`	`init(Context context, String appKey, String packageName, List<NAScanType> defaultEnabledTypes, NARegistrationListener listener)` Initialize the platform with specified device types enabled.
`static void`	`init(Context context, String appKey, String packageName, NARegistrationListener listener)` Initializes the platform.
`abstract boolean`	`isEnabled(NAScanType type)` Returns if scanning is enabled for the given type.
`static boolean`	`isInitialized(Context context)` Check to see if an instance of NewAer is currently operation
`abstract boolean`	`isScanning(NADeviceType type)` Returns true if scans are running for the given device type, i.e.
`abstract void`	`registerDeviceObserver(DataSetObserver observer)` Register an observer to be notified whenever a change occurs on a device or device list which is tagged.
`abstract void`	`registerDeviceStatusListener(NADeviceStatusListener listener)` Register a listener which will be notified when a device status changes.
`abstract void`	`registerMessageListener(NAMessageListener listener)` Registers a listener for messages received.
`abstract void`	`registerScanListener(com.newaer.sdk.proximity.NAScanListener listener)` Register a listener which will be notified when a scan begins.
`abstract boolean`	`sendMessage(NAMessage message)` Sends a message over BLE to a NewAer device.
`abstract void`	`setDebugLogging(boolean enabled)` Enables or disables some internal logging in the SDK.
`abstract void`	`setFriendlyName(String name)` Sets the friendly name for this device.
`abstract void`	`setInfo(byte[] info)` Sets the additional information for this device.
`abstract void`	`setScanInterval(int interval)` Sets the scan interval in seconds.
`abstract void`	`setScanTime(long scanTime)` Sets the scan time in seconds.
`abstract void`	`setScanTypeAsPersistent(NAScanType... types)` Marks these `NAScanType`s as "persistent".
`abstract void`	`startRemoteScan()`
`abstract void`	`startScan()` Start scans for all device types.
`abstract void`	`startScanWithScanTypes(NAScanType... deviceTypes)` Start scans for specified device types
`abstract void`	`stopRemoteScan()`
`abstract void`	`stopScan()` Stop scans for all device type
`abstract void`	`stopScanWithScanTypes(NAScanType... deviceTypes)` Stop scans for specified device types, except BLUETOOTH_LE.
`abstract void`	`unregisterDeviceObserver(DataSetObserver observer)` Unregister a device observer.
`abstract void`	`unregisterDeviceStatusListener(NADeviceStatusListener listener)` Removes a listener previously registered.
`abstract void`	`unregisterMessageListener(NAMessageListener listener)` Unregisters a listener for messages received.
`abstract void`	`unregisterScanListener(com.newaer.sdk.proximity.NAScanListener listener)` Removes a listener previously registered.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SDK_VERSION_MAJOR
```
public static final int SDK_VERSION_MAJOR
```
    The major version number of the platform.
  - SDK_VERSION_MINOR
```
public static final int SDK_VERSION_MINOR
```
    The minor version number of the platform.
  - SDK_VERSION_PATCH
```
public static final int SDK_VERSION_PATCH
```
    The patch number of the platform.
  - SDK_VERSION_CODE
```
public static final String SDK_VERSION_CODE
```
- Constructor Detail
  - NAPlatform
```
protected NAPlatform()
```
    Only subclasses may construct.
- Method Detail
  - getVersion
```
public static String getVersion()
```
    Returns:
    
    the major + minor + patch version number for the platform.
  - get
```
public static NAPlatform get(Context context)
```
    Returns an instance of the NewAer Platform.
    
    Parameters:
    
    context - The Context used to get the platform.
    
    Returns:
    
    the NAPlatform instance for this context.
    
    Throws:
    
    IllegalStateException - if the platform has not yet been initialized.
  - init
```
public static void init(Context context,
                        String appKey,
                        String packageName,
                        NARegistrationListener listener)
```
    Initializes the platform. All device types are disabled by default.
    This method is most easily called in your Application.onCreate() to initialize the NewAer Platform. You can extend NAProximityApp to make it easy to call this method at the correct time for your application.
    
    Parameters:
    
    context - the context to initialize with
    
    appKey - the application key
    
    listener - the listener for registration events.
    
    Throws:
    
    IllegalStateException - if the platform has already been initialized.
  - init
```
public static void init(Context context,
                        String appKey,
                        String packageName,
                        List<NAScanType> defaultEnabledTypes,
                        NARegistrationListener listener)
```
    Initialize the platform with specified device types enabled. Once setEnabled(type) has been called, that value will be persist.
    
    Parameters:
    
    context - the context to initialize for
    
    appKey - the application key
    
    defaultEnabledTypes - scan types to enable by default
    
    listener - the listener for registration events.
    
    Throws:
    
    IllegalStateException - if the platform has already been initialized.
  - destroy
```
public static void destroy(Context context)
```
    Shut down the platform, stopping all scans and dereferencing. This will throw an exception if the platform is not current running.
    
    Parameters:
    
    context - that the platform was created in
    
    Throws:
    
    IllegalStateException - If there is no current instance of the platform
  - isInitialized
```
public static boolean isInitialized(Context context)
```
    Check to see if an instance of NewAer is currently operation
    
    Parameters:
    
    context - that the platform was created in
    
    Returns:
    
    true if the platform exists
  - getNewAerId
```
public abstract String getNewAerId()
```
    Returns a unique identifier which will be seen by others with scanning.
    This id can be used to identify a device running the NewAer platform.
    
    Returns:
    
    the unique identifier for the NewAer platform.
  - getAppId
```
public abstract String getAppId()
```
    Returns:
    
    the App Id passed when initializing the platform.
  - registerDeviceStatusListener
```
public abstract void registerDeviceStatusListener(NADeviceStatusListener listener)
```
    Register a listener which will be notified when a device status changes.
    
    Parameters:
    
    listener - the listener to be notified.
  - unregisterDeviceStatusListener
```
public abstract void unregisterDeviceStatusListener(NADeviceStatusListener listener)
```
    Removes a listener previously registered.
    
    Parameters:
    
    listener - the listener to remove.
  - registerScanListener
```
public abstract void registerScanListener(com.newaer.sdk.proximity.NAScanListener listener)
```
    Register a listener which will be notified when a scan begins.
    
    Parameters:
    
    listener - the listener to be notified.
  - unregisterScanListener
```
public abstract void unregisterScanListener(com.newaer.sdk.proximity.NAScanListener listener)
```
    Removes a listener previously registered.
    
    Parameters:
    
    listener - the listener to remove.
  - setScanTypeAsPersistent
```
public abstract void setScanTypeAsPersistent(NAScanType... types)
```
    Marks these NAScanTypes as "persistent". This means that if the underlying hardware supporting the scantype is turned off (e.g., the user turns off WiFi through the OS settings).
    NOTE 1: Calling this method repeatedly with different values overwrites the previous values stored.
    NOTE 2: stopScanWithScanTypes(NAScanType...) will underlyingly remove any scantypes set here. So, for example, calling:
```
     NAPlatorm.startScanWithScanTypes(NAScanType.WIFI);
     NAPlatform.setScanTypeAsPersistent(NAScanType.WIFI);
     
```
    And then calling NAPlatform.stopScanWithScanTypes(NAScanType.WIFI); will result in the following occurring: NAPlatform.setScanTypeAsPersistent(null); (Assuming that NAScanType.WIFI was the only ScanType set as persistent)
    NOTE 3: Calling NAPlatorm.startScanWithScanTypes again will NOT re-set that scantype as persistent
    Parameters:
    
    types -
  - getPersistentScanTypes
```
public abstract Set<NAScanType> getPersistentScanTypes()
```
    Returns an EnumSet of NAScanTypes previously marked as persistent.
    
    Returns:
  - hasHardware
```
public abstract boolean hasHardware(NADeviceType type)
```
    Returns true if the device has hardware required for discovering a particular device type.
    
    Parameters:
    
    type - the type to check for
    
    Returns:
    
    true if hardware for the type is available.
  - isEnabled
```
public abstract boolean isEnabled(NAScanType type)
```
    Returns if scanning is enabled for the given type.
    
    Parameters:
    
    type - the type to check for
    
    Returns:
    
    true if the type is available.
  - isScanning
```
public abstract boolean isScanning(NADeviceType type)
```
    Returns true if scans are running for the given device type, i.e. the system radio is turned on. The type must also be enabled in order to scan. See startScanWithScanTypes(NAScanType...)
    
    Parameters:
    
    type - the type to inquire about
    
    Returns:
    
    true if scan is running, false otherwise
  - startScan
```
public abstract void startScan()
```
    Start scans for all device types.
  - startScanWithScanTypes
```
public abstract void startScanWithScanTypes(NAScanType... deviceTypes)
```
    Start scans for specified device types
    
    Parameters:
    
    deviceTypes -
  - stopScan
```
public abstract void stopScan()
```
    Stop scans for all device type
  - stopScanWithScanTypes
```
public abstract void stopScanWithScanTypes(NAScanType... deviceTypes)
```
    Stop scans for specified device types, except BLUETOOTH_LE.
    
    Parameters:
    
    deviceTypes -
  - startRemoteScan
```
public abstract void startRemoteScan()
```
  - stopRemoteScan
```
public abstract void stopRemoteScan()
```
  - enablePrivateAnnounce
```
public abstract void enablePrivateAnnounce(boolean announce)
```
  - setScanInterval
```
public abstract void setScanInterval(int interval)
```
    Sets the scan interval in seconds.
    A scan is started every interval seconds.
    
    Parameters:
    
    interval - the scan interval in seconds
  - getScanInterval
```
public abstract int getScanInterval()
```
    Returns:
    
    the scan interval in seconds
  - setScanTime
```
public abstract void setScanTime(long scanTime)
```
    Sets the scan time in seconds.
    
    The BLE scanner is held on for scanTime seconds.
    
    This should be less then the interval or a scan will only be performed every other interval, since a full scan takes slightly longer than the time the BLE Scanner is running due to book keeping.
    
    Parameters:
    
    scanTime - the time the BLE scanner is held on.
  - getScanTime
```
public abstract long getScanTime()
```
    Returns:
    
    the scanTime in seconds.
  - getAllDevices
```
public abstract List<NADevice> getAllDevices()
```
    Returns a collection of devices the platform has recently seen. Devices in this list may not be in subsequent calls to the method.
    This devices in this list are actively managed by the platform. This means that the state of devices in this list may change at any time.
    This list is intended to allow applications to display a list of recently seen devices for tagging.
    
    Returns:
    
    returns all non-tagged devices
  - getAllDevicesByType
```
public abstract List<NADevice> getAllDevicesByType(NADeviceType type)
```
    Returns a collection of devices the platform has recently seen. Devices in this list may not be in subsequent calls to the method.
    This devices in this list are actively managed by the platform. This means that the state of devices in this list may change at any time.
    This list is intended to allow applications to display a list of recently seen devices for tagging.
    
    Parameters:
    
    type - the type of devices to get
    
    Returns:
    
    returns all non-tagged devices of the requested type
  - registerDeviceObserver
```
public abstract void registerDeviceObserver(DataSetObserver observer)
```
    Register an observer to be notified whenever a change occurs on a device or device list which is tagged.
    The observer will be called when any of the get device lists has a change in membership or state of a member.
    
    Parameters:
    
    observer - the observer to register.
  - unregisterDeviceObserver
```
public abstract void unregisterDeviceObserver(DataSetObserver observer)
```
    Unregister a device observer.
    
    Parameters:
    
    observer - the observer to register.
  - getDevice
```
public abstract NADevice getDevice(String id)
```
    Retrieves a device by it's id. Note that untagged devices may not be retrieved using this method.
    
    Parameters:
    
    id - the id of the device to retrieve.
    
    Returns:
    
    the device, if it is tagged, or else null.
  - sendMessage
```
public abstract boolean sendMessage(NAMessage message)
```
    Sends a message over BLE to a NewAer device.
    
    Parameters:
    
    message -
    
    Returns:
    
    true if the message was successfully queued; false if the recipient is not a locally-discovered NADeviceType.NEWAER device.
  - setDebugLogging
```
public abstract void setDebugLogging(boolean enabled)
```
    Enables or disables some internal logging in the SDK.
    
    Parameters:
    
    enabled - true to enable logging.
  - setInfo
```
public abstract void setInfo(byte[] info)
```
    Sets the additional information for this device. Note that this must be less than 90 bytes.
    
    Parameters:
    
    info - the info to set
    
    Throws:
    
    IllegalArgumentException - if info.length > 90
  - getInfo
```
public abstract byte[] getInfo()
```
    Returns:
    
    the additional information for this device.
  - getFriendlyName
```
public abstract String getFriendlyName()
```
    Returns the friendly name for this device. This defaults to the Bluetooth advertising name if available, otherwise null, but can be overridden by setFriendlyName(String).
    
    Returns:
    
    the friendly name for this device.
  - setFriendlyName
```
public abstract void setFriendlyName(String name)
```
    Sets the friendly name for this device. Set to null to reset to the default Bluetooth advertising name. Note this name must be less than 256 bytes when UTF-8 encoded.
    
    Parameters:
    
    name - the friendly name to set
    
    Throws:
    
    IllegalArgumentException - if name.getBytes("UTF-8").length > 256
  - registerMessageListener
```
public abstract void registerMessageListener(NAMessageListener listener)
```
    Registers a listener for messages received.
    
    Parameters:
    
    listener - the listener to register
  - unregisterMessageListener
```
public abstract void unregisterMessageListener(NAMessageListener listener)
```
    Unregisters a listener for messages received.
    
    Parameters:
    
    listener - the listener to unregister

Class NAPlatform

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SDK_VERSION_MAJOR

SDK_VERSION_MINOR

SDK_VERSION_PATCH

SDK_VERSION_CODE

Constructor Detail

NAPlatform

Method Detail

getVersion

get

init

init

destroy

isInitialized

getNewAerId

getAppId

registerDeviceStatusListener

unregisterDeviceStatusListener

registerScanListener

unregisterScanListener

setScanTypeAsPersistent

getPersistentScanTypes

hasHardware

isEnabled

isScanning

startScan

startScanWithScanTypes

stopScan

stopScanWithScanTypes

startRemoteScan

stopRemoteScan

enablePrivateAnnounce

setScanInterval

getScanInterval

setScanTime

getScanTime

getAllDevices

getAllDevicesByType

registerDeviceObserver

unregisterDeviceObserver

getDevice

sendMessage

setDebugLogging

setInfo

getInfo

getFriendlyName

setFriendlyName

registerMessageListener

unregisterMessageListener