MesosferNotification

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

```
public final class MesosferNotification
extends java.lang.Object
```
The MesosferNotification is a custom local representation of notification data that can be saved and retrieved from the Mesosfer cloud.
The basic workflow for creating new data is to construct a new MesosferNotification by accessing createNotification(), use setter method to fill it with notification 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 MesosferNotification.Type
The enum Type.

Nested Classes
Modifier and Type	Class and Description
`static class`	`MesosferNotification.Type` The enum Type.

Constructor Summary

Constructors
Constructor and Description

MesosferNotification()

Constructors
Constructor and Description
`MesosferNotification()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static MesosferNotification`	`createNotification()` Constructs a new `MesosferNotification` with no data in it.
`static MesosferNotification`	`createWithObjectId(java.lang.String objectId)` Creates a reference to an existing `MesosferNotification`.
`void`	`deleteAsync(DeleteCallback callback)` Deletes this object on the server in a background thread.
`void`	`fetchAsync(GetCallback<MesosferNotification> callback)` Fetches this object with the data from the server in a background thread.
`MesosferBeacon`	`getBeacon()` Gets the `MesosferBeacon` that already saved in `MesosferNotification`.
`java.util.Date`	`getCreatedAt()` This reports time as the server sees it, so that if you create a `MesosferNotification`, 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.
`java.lang.String`	`getDescription()` Gets description of notification.
`MesosferBeacon.Event`	`getEvent()` Gets the `MesosferBeacon.Event` that already saved in `MesosferNotification`.
`MesosferObject`	`getMessage()` Gets the `MesosferObject` that already saved in `MesosferNotification`.
`java.lang.String`	`getObjectId()` Accessor to the object id.
`static MesosferQuery<MesosferNotification>`	`getQuery()` Constructs a query for `MesosferNotification`.
`MesosferNotification.Type`	`getType()` Gets the `MesosferNotification.Type` that already saved in `MesosferNotification`.
`java.util.Date`	`getUpdatedAt()` This reports time as the server sees it, so that if you make changes to a `MesosferNotification`, 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 `MesosferNotification` has been fetched.
`boolean`	`isEnabled()` Flag that indicate `MesosferNotification` is enabled or disabled.
`MesosferNotification`	`isEnabled(boolean enabled)` Sets enabled or disabled for notification.
`void`	`saveAsync(SaveCallback callback)` Saves this object with the data from the server in a background thread.
`MesosferNotification`	`setBeacon(MesosferBeacon beacon)` Sets notification beacon.
`MesosferNotification`	`setDescription(java.lang.String description)` Sets notification description.
`MesosferNotification`	`setEvent(MesosferBeacon.Event event)` Sets event for notification.
`MesosferNotification`	`setMessage(MesosferObject message)` Sets notification message.
`MesosferNotification`	`setType(MesosferNotification.Type type)` Sets type for notification.
`org.json.JSONObject`	`toJSON()` To put all keys and values of this `MesosferNotification` into a `JSONObject`.
`java.lang.String`	`toString()`

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

- Constructor Detail
  - MesosferNotification
```
public MesosferNotification()
```
- Method Detail
  - createWithObjectId
```
public static MesosferNotification createWithObjectId(java.lang.String objectId)
```
    Creates a reference to an existing MesosferNotification. Calling isDataAvailable() on this object will return false until fetchAsync(GetCallback) has been called.
    
    Parameters:
    
    objectId - The object id for the referenced notification object.
    
    Returns:
    
    A MesosferNotification without data.
  - createNotification
```
public static MesosferNotification createNotification()
```
    Constructs a new MesosferNotification with no data in it. A MesosferNotification constructed in this way will not have an objectId and will not persist to the database until saveAsync(SaveCallback) is called.
    
    Returns:
    
    A new instance of MesosferNotification
  - getDescription
```
public java.lang.String getDescription()
```
    Gets description of notification.
    
    Returns:
    
    the String name of notification.
  - getMessage
```
public MesosferObject getMessage()
```
    Gets the MesosferObject that already saved in MesosferNotification.
    
    Returns:
    
    the MesosferObject
  - getBeacon
```
public MesosferBeacon getBeacon()
```
    Gets the MesosferBeacon that already saved in MesosferNotification.
    
    Returns:
    
    the MesosferBeacon
  - isEnabled
```
public boolean isEnabled()
```
    Flag that indicate MesosferNotification is enabled or disabled.
    
    Returns:
    
    true if enabled and false for otherwise.
  - getEvent
```
public MesosferBeacon.Event getEvent()
```
    Gets the MesosferBeacon.Event that already saved in MesosferNotification.
    
    Returns:
    
    the MesosferBeacon.Event
  - getType
```
public MesosferNotification.Type getType()
```
    Gets the MesosferNotification.Type that already saved in MesosferNotification.
    
    Returns:
    
    the MesosferNotification.Type
  - isDataAvailable
```
public boolean isDataAvailable()
```
    Gets whether the MesosferNotification has been fetched.
    
    Returns:
    
    true if the MesosferNotification 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 MesosferNotification, 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 MesosferNotification, 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 MesosferNotification 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<MesosferNotification> getQuery()
```
    Constructs a query for MesosferNotification.
    
    Returns:
    
    the query instance.
  - setDescription
```
public MesosferNotification setDescription(java.lang.String description)
```
    Sets notification description.
    
    Parameters:
    
    description - the description of notification.
    
    Returns:
    
    the current instance for chaining method use.
  - setMessage
```
public MesosferNotification setMessage(MesosferObject message)
```
    Sets notification message.
    
    Parameters:
    
    message - the message
    
    Returns:
    
    the current instance for chaining method use.
  - setBeacon
```
public MesosferNotification setBeacon(MesosferBeacon beacon)
```
    Sets notification beacon.
    
    Parameters:
    
    beacon - the MesosferBeacon
    
    Returns:
    
    the current instance for chaining method use.
  - isEnabled
```
public MesosferNotification isEnabled(boolean enabled)
```
    Sets enabled or disabled for notification.
    
    Parameters:
    
    enabled - true if enabled and false for otherwise.
    
    Returns:
    
    the current instance for chaining method use.
  - setEvent
```
public MesosferNotification setEvent(MesosferBeacon.Event event)
```
    Sets event for notification.
    
    Parameters:
    
    event - the MesosferBeacon.Event
    
    Returns:
    
    the current instance for chaining method use.
  - setType
```
public MesosferNotification setType(MesosferNotification.Type type)
```
    Sets type for notification.
    
    Parameters:
    
    type - the MesosferNotification.Type
    
    Returns:
    
    the current instance for chaining method use.
  - 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<MesosferNotification> 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 MesosferNotification

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MesosferNotification

Method Detail

createWithObjectId

createNotification

getDescription

getMessage

getBeacon

isEnabled

getEvent

getType

isDataAvailable

getObjectId

getCreatedAt

getUpdatedAt

toJSON

toString

getQuery

setDescription

setMessage

setBeacon

isEnabled

setEvent

setType

deleteAsync

saveAsync

fetchAsync