fm.audiobox.core.models

Class Notification

java.lang.Object

java.util.Observable

fm.audiobox.core.models.Model

fm.audiobox.core.models.Notification

public class Notification
extends Model

Notifications are system messages that the AudioBox will send the user, for example when a Cloud Drive needs to be re-authenticated or if some operation fails.

There are four different notification levels: `error`, `success`, `info` and `warning`.

Constructor Summary

Constructors

Constructor and Description
Notification()

Method Summary

Methods

Modifier and Type	Method and Description
Notification	delete(AudioBoxClient audioBoxClient) Performs a Notification deletion.
java.lang.String	getBody() Gets the content body of the notification message.
java.lang.String	getCreatedAt() Gets the UTC creation time in String format.
long	getId() Gets the notification id.
java.lang.String	getLevel() Gets the severity of the message.
static java.lang.String	getPath() Gets the generic remote resource path (ID interpolation is needed).

Methods inherited from class fm.audiobox.core.models.Model

getProp, notifyObservers, setProp

Methods inherited from class java.util.Observable

addObserver, clearChanged, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, setChanged

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Notification

public Notification()

Method Detail

getId

public long getId()

Gets the notification id.

Returns:

the id of the notification

getBody

public java.lang.String getBody()

Gets the content body of the notification message.

Returns:

the message body

getLevel

public java.lang.String getLevel()

Gets the severity of the message.

Returns:

the level (one of `error`, `success`, `info` and `warning`)

getCreatedAt

public java.lang.String getCreatedAt()

Gets the UTC creation time in String format.

Returns:

the UTC creation time

getPath

public static java.lang.String getPath()

Gets the generic remote resource path (ID interpolation is needed).

Returns:

the path String

delete

public Notification delete(AudioBoxClient audioBoxClient)
                    throws java.io.IOException

Performs a Notification deletion. If deletion cannot be accomplished an exception is thrown.

Returns:

true if deletion succeeds

Throws:

AudioBoxException - if any of the remote error exception is detected.

java.io.IOException - if any connection problem occurs.

See Also:

AudioBoxException