Package com.syzygy.events.database

Class Notification

java.lang.Object

com.syzygy.events.database.DatabaseInstance<Notification>

com.syzygy.events.database.Notification

All Implemented Interfaces:

Database.Dissolvable, Database.UpdateListener

@Dissolves
public class Notification
extends DatabaseInstance<Notification>

An instance of a notification database item - A notification item cannot be edited

Nested Class Summary

Nested classes/interfaces inherited from class com.syzygy.events.database.DatabaseInstance

DatabaseInstance.DeletionType, DatabaseInstance.InstancePropertyWrapper<W extends DatabaseInstance<W>>, DatabaseInstance.PropertyField<V,W extends DatabaseInstance<W>>, DatabaseInstance.PropertyWrapper<V,W extends DatabaseInstance<W>>

Nested classes/interfaces inherited from interface com.syzygy.events.database.Database.UpdateListener

Database.UpdateListener.Type

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static final DatabaseInstance.PropertyField<?,?>[]	fields	The list of the fields defined for a User

Fields inherited from class com.syzygy.events.database.DatabaseInstance

db, iproperties, properties

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Notification(Database db, String id)	Checks to make sure the generic type is the type of this instance

Method Summary

Modifier and Type	Method	Description
protected Notification	cast()	Gets this instance casted to the generic type
String	getBody()
Event	getEvent()
String	getEventID()
Boolean	getIsRead()
User	getReceiver()
String	getReceiverID()
User	getSender()
String	getSenderID()
com.google.firebase.Timestamp	getSentTime()
String	getSubject()
Boolean	ignoresOptOutSettings()
static Set<Integer>	NewInstance(Database db, String subject, String body, String eventID, String receiverID, String senderID, Boolean ignoresOptOut, Database.InitializationListener<Notification> listener)	Validates and creates a new notification instance in the database using the given data.
Boolean	setIsRead(Boolean b)
protected List<android.util.Pair<com.google.firebase.firestore.Query,Database.Collections>>	subInstanceCascadeDeleteQuery()

Methods inherited from class com.syzygy.events.database.DatabaseInstance

addInitializationListener, addListener, assertNotIllegalState, deleteInstance, dereferenceInstance, dissolve, dissolve, doesPropertyLoadInstance, fetch, fetch, fullDissolve, getAssociatedImage, getAssociatedImageLocName, getCollection, getCollectionReference, getData, getDatabaseID, getDocumentID, getDocumentReference, getFields, getPropertyInstance, getPropertyInstanceI, getPropertyValue, getPropertyValueI, initializeData, isDataValid, isDataValid, isLegalState, isPropertyEditable, isPropertyValid, isPropertyValid, isReferenced, modifyData, notifyUpdate, onUpdate, processUpdate, removeListener, requiredFirstDelete, setAssociatedImage, setPropertyInstance, setPropertyValue, subDereferenceInstance, subInitialize, toString, updateDataFromDatabase, updateDataFromMap, updateDataFromMap

Methods inherited from class java.lang.Object

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

Field Details

fields

static final DatabaseInstance.PropertyField<?,?>[] fields

The list of the fields defined for a User

Constructor Details

Notification

@Salty
protected Notification(Database db,
 String id)
                throws ClassCastException

Checks to make sure the generic type is the type of this instance

Parameters:

db - The database

id - The id of the notification

Throws:

ClassCastException

Method Details

cast

@Observes
protected Notification cast()

Description copied from class: DatabaseInstance

Gets this instance casted to the generic type

Specified by:

cast in class DatabaseInstance<Notification>

Returns:

This as the generic type

getSubject

public String getSubject()

getBody

public String getBody()

getSentTime

public com.google.firebase.Timestamp getSentTime()

getIsRead

public Boolean getIsRead()

getEventID

public String getEventID()

getSenderID

public String getSenderID()

getReceiverID

public String getReceiverID()

getEvent

@Observes
public Event getEvent()

getSender

@Observes
public User getSender()

getReceiver

@Observes
public User getReceiver()

setIsRead

public Boolean setIsRead(Boolean b)

ignoresOptOutSettings

public Boolean ignoresOptOutSettings()

subInstanceCascadeDeleteQuery

protected List<android.util.Pair<com.google.firebase.firestore.Query,Database.Collections>> subInstanceCascadeDeleteQuery()

Specified by:

subInstanceCascadeDeleteQuery in class DatabaseInstance<Notification>

Returns:

A list of all querries that should be run whose instances will be deleted when this instance is deleted

NewInstance

@MustStir
public static Set<Integer> NewInstance(Database db,
 String subject,
 String body,
 @Dilutes
 String eventID,
 @Dilutes
 String receiverID,
 @Dilutes
 String senderID,
 Boolean ignoresOptOut,
 Database.InitializationListener<Notification> listener)

Validates and creates a new notification instance in the database using the given data.

Sets isRead to false

Parameters:

db - The database

subject - The subject of the notification

body - The body of the notification

eventID - The ID of the event associated to the notification

receiverID - The id of the receiver

senderID - The id of the sender

ignoresOptOut - If the notification cannot be opted out of

listener - Will be called once the notification is initialized. Is not called if the data is invalid

Returns:

The property id of all invalid properties

See Also:

• Database.createNewInstance(Database.Collections, String, Map, Database.InitializationListener)