MesosferStoryline

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

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

static class MesosferStoryline.ShowDay
The enum Show day.

Nested Classes
Modifier and Type	Class and Description
`static class`	`MesosferStoryline.Campaign` The enum Campaign.
`static class`	`MesosferStoryline.ShowDay` The enum Show day.

Constructor Summary

Constructors
Constructor and Description

MesosferStoryline()

Constructors
Constructor and Description
`MesosferStoryline()`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static MesosferStoryline`	`createStoryline()` Constructs a new `MesosferStoryline` with no data in it.
`static MesosferStoryline`	`createWithObjectId(java.lang.String objectId)` Creates a reference to an existing `MesosferStoryline`.
`void`	`deleteAsync(DeleteCallback callback)` Deletes this object on the server in a background thread.
`void`	`fetchAsync(GetCallback<MesosferStoryline> 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 `MesosferStoryline`, 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`	`getObjectId()` Accessor to the object id.
`static MesosferQuery<MesosferStoryline>`	`getQuery()` Constructs a query for `MesosferStoryline`.
`java.lang.String`	`getTitle()` Gets storyline title.
`java.util.Date`	`getUpdatedAt()` This reports time as the server sees it, so that if you make changes to a `MesosferStoryline`, 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 `MesosferStoryline` has been fetched.
`boolean`	`isEnabled()` Flag that indicate if storyline is enabled or disabled.
`MesosferStoryline`	`isEnabled(boolean enabled)` Sets to enable or disable storyline.
`void`	`saveAsync(SaveCallback callback)` Saves this object with the data from the server in a background thread.
`MesosferStoryline`	`setTitle(java.lang.String title)` Sets storyline title.
`org.json.JSONObject`	`toJSON()` To put all keys and values of this `MesosferData` into a `JSONObject`.
`java.lang.String`	`toString()`

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

- Constructor Detail
  - MesosferStoryline
```
public MesosferStoryline()
```
- Method Detail
  - createWithObjectId
```
public static MesosferStoryline createWithObjectId(java.lang.String objectId)
```
    Creates a reference to an existing MesosferStoryline. Calling isDataAvailable() on this object will return false until fetchAsync(GetCallback) has been called.
    
    Parameters:
    
    objectId - The object id for the referenced storyline object.
    
    Returns:
    
    A MesosferStoryline without data.
  - createStoryline
```
public static MesosferStoryline createStoryline()
```
    Constructs a new MesosferStoryline with no data in it. A MesosferStoryline 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 MesosferStoryline
  - getTitle
```
public java.lang.String getTitle()
```
    Gets storyline title.
    
    Returns:
    
    the storyline title.
  - isEnabled
```
public boolean isEnabled()
```
    Flag that indicate if storyline is enabled or disabled.
    
    Returns:
    
    true if enabled, false otherwise.
  - isDataAvailable
```
public boolean isDataAvailable()
```
    Gets whether the MesosferStoryline has been fetched.
    
    Returns:
    
    true if the MesosferStoryline 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 MesosferStoryline, 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 MesosferStoryline, 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 MesosferData 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<MesosferStoryline> getQuery()
```
    Constructs a query for MesosferStoryline.
    
    Returns:
    
    the query instance.
  - setTitle
```
public MesosferStoryline setTitle(java.lang.String title)
```
    Sets storyline title.
    
    Parameters:
    
    title - the storyline title
    
    Returns:
    
    the current instance for chaining method use.
  - isEnabled
```
public MesosferStoryline isEnabled(boolean enabled)
```
    Sets to enable or disable storyline.
    
    Parameters:
    
    enabled - true to enabled, false otherwise
    
    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<MesosferStoryline> 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 MesosferStoryline

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MesosferStoryline

Method Detail

createWithObjectId

createStoryline

getTitle

isEnabled

isDataAvailable

getObjectId

getCreatedAt

getUpdatedAt

toJSON

toString

getQuery

setTitle

isEnabled

deleteAsync

saveAsync

fetchAsync