NADevice (newaer-sdk-proximity API)

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

All Implemented Interfaces:

Comparable<NADevice>

Direct Known Subclasses:

NADeviceImpl
```
public abstract class NADevice
extends Object
```
The representation of a device detected by the ProxPlatform.
This class also provides convenience methods for working with devices the platform knows about.
An instance of NADevice is actively backed by the device in the system, so any calls into the device return the current state of the device as known to the system at the time of the call. The state of the device may be updated at any time.
If your application needs to know when a device is updated you can register an observer. This observer will be called when a device in the system changes state, however which device is not specified via this interface.

Field Summary

Fields
Modifier and Type	Field and Description
`static Comparator<NADevice>`	`COMPARATOR_MAJOR_MINOR` Comparator for sorting by Major/Minor.
`static Comparator<NADevice>`	`COMPARATOR_SIGNAL_STRENGTH` Comparator for sorting by signal strength.

Constructor Summary

Constructors
Modifier Constructor and Description

protected NADevice()
Only subclass construction.

Constructors
Modifier	Constructor and Description
`protected`	`NADevice()` Only subclass construction.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`compareTo(NADevice other)` This is the default way to compare NADevices when sorting them in a list.
`int`	`compareTo(com.newaer.sdk.proximity.NAObject another)`
`abstract NAMessage`	`createMessageToSend(byte[] message)` Gets a message to be sent to this device.
`boolean`	`equals(Object another)`
`static List<NADevice>`	`getAllByType(Context context, NADeviceType type)` This is a convenience for `NAPlatform.get(context).getAllUntaggedDevicesByType(type)`
`static List<NADevice>`	`getAllDevices(Context context)` This is a convenience for `NAPlatform.get(context).getAllDevices()`
`abstract String`	`getAppId()` This returns the application ID of the app which has this device, or null if this device is not of type NEWAER_DEVICE.
`abstract String`	`getBeaconUUID()`
`static NADevice`	`getDevice(Context context, String id)` This is a convenience for `NAPlatform.get(context).getDevice(id)`
`abstract String`	`getId()` Returns the identifier for this object within the platform.
`abstract byte[]`	`getInfo()` This returns extra information set via `NAPlatform.setInfo(byte[])`.
`abstract long`	`getLastSeenTimestamp()`
`abstract int`	`getMajor()`
`abstract int`	`getMinor()`
`abstract String`	`getName()` Returns a human friendly name for this device.
`abstract int`	`getPowerbars()` Returns the number of power bars to display for this device, from zero to five.
`abstract int`	`getSignalStrength()`
`abstract NADeviceStatus`	`getStatus()`
`abstract int`	`getTxPower()`
`abstract NADeviceType`	`getType()`
`int`	`hashCode()`
`abstract boolean`	`isRemote()`
`static void`	`registerObserver(Context context, DataSetObserver observer)` This is a convenience for `NAPlatform.get(context).registerDeviceObserver(observer)`
`static void`	`registerStatusListener(Context context, NADeviceStatusListener listener)` This is a convenience for `NAPlatform.get(context).registerDeviceStatusListener(NADeviceStatusListener)`
`abstract void`	`setName(Context context, String name)` Change the name for this object.
`static void`	`unregisterObserver(Context context, DataSetObserver observer)` This is a convenience for `NAPlatform.get(context).unregisterDeviceObserver(observer)`
`static void`	`unregisterStatusListener(Context context, NADeviceStatusListener listener)` This is a convenience for `NAPlatform.get(context).unregisterDeviceStatusListener(NADeviceStatusListener)`

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

- Field Detail
  - COMPARATOR_SIGNAL_STRENGTH
```
public static final Comparator<NADevice> COMPARATOR_SIGNAL_STRENGTH
```
    Comparator for sorting by signal strength. The devices are first sorted by status, as with the default comparator, then by power bars, and then by name.
  - COMPARATOR_MAJOR_MINOR
```
public static final Comparator<NADevice> COMPARATOR_MAJOR_MINOR
```
    Comparator for sorting by Major/Minor. The devices are first sorted by status, as with the default comparator, then by power bars, and then by name.
- Constructor Detail
  - NADevice
```
protected NADevice()
```
    Only subclass construction.
- Method Detail
  - getAllByType
```
public static List<NADevice> getAllByType(Context context,
                                          NADeviceType type)
```
    This is a convenience for NAPlatform.get(context).getAllUntaggedDevicesByType(type)
    
    Parameters:
    
    context - the context to work in
    
    type - the type of devices to get
    
    Returns:
    
    returns all non-tagged devices of the requested type
  - getAllDevices
```
public static List<NADevice> getAllDevices(Context context)
```
    This is a convenience for NAPlatform.get(context).getAllDevices()
    
    Parameters:
    
    context - the context to work in
    
    Returns:
    
    returns all non-tagged devices of the requested type
  - registerObserver
```
public static void registerObserver(Context context,
                                    DataSetObserver observer)
```
    This is a convenience for NAPlatform.get(context).registerDeviceObserver(observer)
    
    Parameters:
    
    context - the context to work in.
    
    observer - the observer to register.
  - unregisterObserver
```
public static void unregisterObserver(Context context,
                                      DataSetObserver observer)
```
    This is a convenience for NAPlatform.get(context).unregisterDeviceObserver(observer)
    
    Parameters:
    
    context - the context to work in
    
    observer - the observer to register.
  - getDevice
```
public static NADevice getDevice(Context context,
                                 String id)
```
    This is a convenience for NAPlatform.get(context).getDevice(id)
    
    Parameters:
    
    context - the context to work in
    
    id - the id of the device to retrieve.
    
    Returns:
    
    the device if it is tagged or else null.
  - registerStatusListener
```
public static void registerStatusListener(Context context,
                                          NADeviceStatusListener listener)
```
    This is a convenience for NAPlatform.get(context).registerDeviceStatusListener(NADeviceStatusListener)
    
    Parameters:
    
    context - the context to work in
    
    listener - the listener to register
  - unregisterStatusListener
```
public static void unregisterStatusListener(Context context,
                                            NADeviceStatusListener listener)
```
    This is a convenience for NAPlatform.get(context).unregisterDeviceStatusListener(NADeviceStatusListener)
    
    Parameters:
    
    context - the context to work in
    
    listener - the listener to unregister
  - getType
```
public abstract NADeviceType getType()
```
    Returns:
    
    the type of the device
  - getSignalStrength
```
public abstract int getSignalStrength()
```
    Returns:
    
    the current signal strength of the device
  - getStatus
```
public abstract NADeviceStatus getStatus()
```
    Returns:
    
    the status of the device
  - getName
```
public abstract String getName()
```
    Returns a human friendly name for this device.
    
    Returns:
    
    the name for the object.
  - getPowerbars
```
public abstract int getPowerbars()
```
    Returns the number of power bars to display for this device, from zero to five.
    
    Returns:
    
    the number of power bars to display, 0 to 5.
  - compareTo
```
public int compareTo(NADevice other)
```
    This is the default way to compare NADevices when sorting them in a list. The ordering is determined first by status, with in range followed by out of range, then unknown. Within the status groups, devices are sorted by name.
  - getLastSeenTimestamp
```
public abstract long getLastSeenTimestamp()
```
    Returns:
    
    the Unix Epoch Timestamp of the last time this device was seen.
  - getInfo
```
public abstract byte[] getInfo()
```
    This returns extra information set via NAPlatform.setInfo(byte[]). If no information has been set, or this device is not of type NADeviceType.NEWAER then this returns null.
    
    Returns:
    
    information set via NAPlatform.setInfo(byte[]) or null
  - getAppId
```
public abstract String getAppId()
```
    This returns the application ID of the app which has this device, or null if this device is not of type NEWAER_DEVICE.
    
    Returns:
    
    the application ID of the app running on this device.
  - createMessageToSend
```
public abstract NAMessage createMessageToSend(byte[] message)
```
    Gets a message to be sent to this device.
    
    Returns:
    
    a message to be sent to this device.
  - getMajor
```
public abstract int getMajor()
```
  - getMinor
```
public abstract int getMinor()
```
  - getBeaconUUID
```
public abstract String getBeaconUUID()
```
  - getTxPower
```
public abstract int getTxPower()
```
  - isRemote
```
public abstract boolean isRemote()
```
  - getId
```
public abstract String getId()
```
    Returns the identifier for this object within the platform.
    This identifier is unique on a per object type basis.
    
    Returns:
    
    the identifier for the object.
  - setName
```
public abstract void setName(Context context,
                             String name)
```
    Change the name for this object.
    
    Parameters:
    
    context - the context to work in
    
    name - the new name for this object.
  - compareTo
```
public int compareTo(com.newaer.sdk.proximity.NAObject another)
```
    Specified by:
    
    compareTo in interface Comparable<T extends com.newaer.sdk.proximity.NAObject>
  - equals
```
public boolean equals(Object another)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class NADevice

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

COMPARATOR_SIGNAL_STRENGTH

COMPARATOR_MAJOR_MINOR

Constructor Detail

NADevice

Method Detail

getAllByType

getAllDevices

registerObserver

unregisterObserver

getDevice

registerStatusListener

unregisterStatusListener

getType

getSignalStrength

getStatus

getName

getPowerbars

compareTo

getLastSeenTimestamp

getInfo

getAppId

createMessageToSend

getMajor

getMinor

getBeaconUUID

getTxPower

isRemote

getId

setName

compareTo

equals

hashCode