MesosferBeacon

java.lang.Object
- com.eyro.mesosfer.MesosferBeacon

```
public final class MesosferBeacon
extends java.lang.Object
```
The MesosferBeacon is a custom local representation of beacon data that can be saved and retrieved from the Mesosfer cloud.
The basic workflow for creating new data is to construct a new MesosferBeacon by accessing createBeacon(), use setter method to fill it with beacon data, and then use saveAsync(SaveCallback) to persist to the cloud.
The basic workflow for accessing existing data is to use a MesosferQuery to specify which existing data to retrieve.

Author:

Eyro Labs

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class MesosferBeacon.Event
The enum Event of beacon.

static class MesosferBeacon.Module
The enum Module of beacon.

Nested Classes
Modifier and Type	Class and Description
`static class`	`MesosferBeacon.Event` The enum Event of beacon.
`static class`	`MesosferBeacon.Module` The enum Module of beacon.

Constructor Summary

Constructors
Constructor and Description

MesosferBeacon()

Constructors
Constructor and Description
`MesosferBeacon()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static MesosferBeacon`	`createBeacon()` Constructs a new `MesosferBeacon` with no data in it.
`static MesosferBeacon`	`createWithObjectId(java.lang.String objectId)` Creates a reference to an existing `MesosferBeacon`.
`void`	`deleteAsync(DeleteCallback callback)` Deletes this object on the server in a background thread.
`void`	`fetchAsync(GetCallback<MesosferBeacon> callback)` Fetches this object with the data from the server in a background thread.
`java.util.Date`	`getCreatedAt()` This reports time as the server sees it, so that if you create a `MesosferBeacon`, then wait a while, and then call `saveAsync(SaveCallback)`, the creation time will be the time of the first `saveAsync(SaveCallback)` call rather than the time the object was created locally.
`MesosferObject`	`getData()` Gets the `MesosferObject` that already saved in `MesosferBeacon`.
`int`	`getMajor()` Gets major number of beacon.
`int`	`getMinor()` Gets minor number of beacon.
`java.lang.String`	`getName()` Gets name of beacon.
`java.lang.String`	`getObjectId()` Accessor to the object id.
`java.util.UUID`	`getProximityUUID()` Gets proximity `UUID` of beacon.
`static MesosferQuery<MesosferBeacon>`	`getQuery()` Constructs a query for `MesosferBeacon`.
`java.util.Date`	`getUpdatedAt()` This reports time as the server sees it, so that if you make changes to a `MesosferBeacon`, then wait a while, and then call `saveAsync(SaveCallback)`, the updated time will be the time of the `saveAsync(SaveCallback)` call rather than the time the object was changed locally.
`boolean`	`isDataAvailable()` Gets whether the `MesosferBeacon` has been fetched.
`void`	`saveAsync(SaveCallback callback)` Saves this object with the data from the server in a background thread.
`MesosferBeacon`	`setData(java.lang.String key, java.lang.Object value)` Add a key-value pair to this object.
`MesosferBeacon`	`setMajor(int major)` Sets major number of beacon.
`MesosferBeacon`	`setMinor(int minor)` Sets minor number of beacon.
`MesosferBeacon`	`setName(java.lang.String name)` Sets name of beacon.
`MesosferBeacon`	`setProximityUUID(java.util.UUID uuid)` Sets proximity `UUID` of beacon.
`org.json.JSONObject`	`toJSON()` To put all keys and values of this `MesosferBeacon` into a `JSONObject`.
`java.lang.String`	`toString()`

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

- Constructor Detail
  - MesosferBeacon
```
public MesosferBeacon()
```
- Method Detail
  - createWithObjectId
```
public static MesosferBeacon createWithObjectId(java.lang.String objectId)
```
    Creates a reference to an existing MesosferBeacon. Calling isDataAvailable() on this object will return false until fetchAsync(GetCallback) has been called.
    
    Parameters:
    
    objectId - The object id for the referenced beacon object.
    
    Returns:
    
    A MesosferBeacon without data.
  - createBeacon
```
public static MesosferBeacon createBeacon()
```
    Constructs a new MesosferBeacon with no data in it. A MesosferBeacon constructed in this way will not have an objectId and will not persist to the database until saveAsync(SaveCallback) is called.
    Bucket names must be alphanumerical, and must start with a letter. It is recommended to name classes in MesosferCaseLikeThis.
    
    Returns:
    
    A new instance of MesosferBeacon
  - getName
```
public java.lang.String getName()
```
    Gets name of beacon.
    
    Returns:
    
    the String of beacon's name.
  - getProximityUUID
```
public java.util.UUID getProximityUUID()
```
    Gets proximity UUID of beacon. This value represents company identifier.
    
    Returns:
    
    the proximity UUID of beacon.
  - getMajor
```
public int getMajor()
```
    Gets major number of beacon. This value represents major identifier.
    
    Returns:
    
    the major number of beacon.
  - getMinor
```
public int getMinor()
```
    Gets minor number of beacon. This value represents minor identifier.
    
    Returns:
    
    the minor number of beacon.
  - getData
```
public MesosferObject getData()
```
    Gets the MesosferObject that already saved in MesosferBeacon.
    
    Returns:
    
    the MesosferObject
  - isDataAvailable
```
public boolean isDataAvailable()
```
    Gets whether the MesosferBeacon has been fetched.
    
    Returns:
    
    true if the MesosferBeacon is new or has been fetched. false otherwise.
  - getObjectId
```
public java.lang.String getObjectId()
```
    Accessor to the object id. An object id is assigned as soon as an object is saved to the server. The combination of a bucketName and an objectId uniquely identifies an object in your application.
    
    Returns:
    
    The object id.
  - getCreatedAt
```
public java.util.Date getCreatedAt()
```
    This reports time as the server sees it, so that if you create a MesosferBeacon, then wait a while, and then call saveAsync(SaveCallback), the creation time will be the time of the first saveAsync(SaveCallback) call rather than the time the object was created locally.
    
    Returns:
    
    The first time this object was saved on the server.
  - getUpdatedAt
```
public java.util.Date getUpdatedAt()
```
    This reports time as the server sees it, so that if you make changes to a MesosferBeacon, then wait a while, and then call saveAsync(SaveCallback), the updated time will be the time of the saveAsync(SaveCallback) call rather than the time the object was changed locally.
    
    Returns:
    
    The last time this object was updated on the server.
  - toJSON
```
public org.json.JSONObject toJSON()
```
    To put all keys and values of this MesosferBeacon into a JSONObject.
    
    Returns:
    
    The JSONObject of all keys and values
  - toString
```
public java.lang.String toString()
```
    Overrides:
    
    toString in class java.lang.Object
  - getQuery
```
public static MesosferQuery<MesosferBeacon> getQuery()
```
    Constructs a query for MesosferBeacon.
    
    Returns:
    
    the query instance.
  - setName
```
public MesosferBeacon setName(java.lang.String name)
```
    Sets name of beacon.
    
    Parameters:
    
    name - the name of beacon.
    
    Returns:
    
    the current instance for chaining method use.
  - setProximityUUID
```
public MesosferBeacon setProximityUUID(java.util.UUID uuid)
```
    Sets proximity UUID of beacon.
    
    Parameters:
    
    uuid - the proximity UUID of beacon.
    
    Returns:
    
    the current instance for chaining method use.
  - setMajor
```
public MesosferBeacon setMajor(int major)
```
    Sets major number of beacon.
    
    Parameters:
    
    major - the major identifier of beacon.
    
    Returns:
    
    the current instance for chaining method use.
  - setMinor
```
public MesosferBeacon setMinor(int minor)
```
    Sets minor number of beacon.
    
    Parameters:
    
    minor - the minor identifier of beacon.
    
    Returns:
    
    the current instance for chaining method use.
  - setData
```
public MesosferBeacon setData(java.lang.String key,
                              java.lang.Object value)
```
    Add a key-value pair to this object. It is recommended to name keys in camelCaseLikeThis.
    
    Parameters:
    
    key - Keys must be alphanumerical, and start with a letter.
    
    value - Values may be numerical, String, JSONObject, JSONArray, JSONObject.NULL, or Dates. value may not be null.
    
    Returns:
    
    This instance of object for chaining mode
  - deleteAsync
```
public void deleteAsync(DeleteCallback callback)
```
    Deletes this object on the server in a background thread. This is the preferable method, unless your code is already running from a background thread.
    
    Parameters:
    
    callback - callback.done(e) is called when the save completes.
  - saveAsync
```
public void saveAsync(SaveCallback callback)
```
    Saves this object with the data from the server in a background thread. This is the preferable method, unless your code is already running from a background thread.
    
    Parameters:
    
    callback - callback.done(e) is called when the save completes.
  - fetchAsync
```
public void fetchAsync(GetCallback<MesosferBeacon> callback)
```
    Fetches this object with the data from the server in a background thread. This is the preferable method, unless your code is already running from a background thread.
    
    Parameters:
    
    callback - callback.done(object, e) is called when the fetch completes.

Class MesosferBeacon

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MesosferBeacon

Method Detail

createWithObjectId

createBeacon

getName

getProximityUUID

getMajor

getMinor

getData

isDataAvailable

getObjectId

getCreatedAt

getUpdatedAt

toJSON

toString

getQuery

setName

setProximityUUID

setMajor

setMinor

setData

deleteAsync

saveAsync

fetchAsync