com.quickblox.messages.model

Class QBEvent

java.lang.Object

com.quickblox.core.model.QBEntity

com.quickblox.messages.model.QBEvent

All Implemented Interfaces:

java.io.Serializable

public class QBEvent
extends QBEntity

Event representation.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.quickblox.core.model.QBEntity

createdAt, id, updatedAt

Constructor Summary

Constructors

Constructor and Description
QBEvent()
QBEvent(int id)

Method Summary

Modifier and Type	Method and Description
void	addUserIds(java.lang.Integer... ids)
void	copyFieldsTo(QBEntity entity) Copy the data of all fields to another instance
java.lang.String	getAPNSMessage()
java.lang.Integer	getApplicationId()
java.lang.Integer	getDate() The date of the event when it'll fire.
java.lang.Integer	getEndDate()
QBEnvironment	getEnvironment()
java.lang.String	getGSMMessage()
java.lang.String	getMessage()
java.lang.String	getMessageEncoded()
java.lang.String	getName()
QBNotificationChannel	getNotificationChannel()
QBNotificationType	getNotificationType()
java.lang.Integer	getOccuredCount()
java.lang.Integer	getPeriod()
QBPushType	getPushType()
QBEventType	getType()
java.lang.Integer	getUserId()
<any>	getUserIds()
<any>	getUserTagsAll()
<any>	getUserTagsAny()
<any>	getUserTagsExclude()
java.lang.Boolean	isActive()
void	setActive(java.lang.Boolean active) Event state.
void	setApplicationId(java.lang.Integer applicationId)
void	setDate(java.lang.Integer date)
void	setEndDate(java.lang.Integer endDate) Date of completion of the event.
void	setEnvironment(QBEnvironment environment)
void	setMessage(java.util.HashMap<java.lang.String,java.lang.Object> data)
void	setMessage(java.lang.String message) Event message
void	setName(java.lang.String name) The name of the event.
void	setNotificationChannel(QBNotificationChannel notificationChannel)
void	setNotificationType(QBNotificationType notificationType) Notification type: push, email, request or pull
void	setOccuredCount(java.lang.Integer occuredCount) Event's occurred count
void	setPeriod(java.lang.Integer period) he period of the event in seconds.
void	setPushType(QBPushType pushType)
void	setType(QBEventType type) Event type
void	setUserId(java.lang.Integer userId) sender ID
void	setUserIds(<any> userIds) Recipients - list of user ids
void	setUserTagsAll(<any> userTagsAll) Recipients tags - list of user tags.
void	setUserTagsAny(<any> userTagsAny) Recipients tags - list of user tags.
void	setUserTagsExclude(<any> userTagsExclude) Recipients tags - list of user tags.
java.lang.String	toString()

Methods inherited from class com.quickblox.core.model.QBEntity

equals, getCreatedAt, getFCreatedAt, getFUpdatedAt, getId, getUpdatedAt, hashCode, setCreatedAt, setId, setUpdatedAt

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

QBEvent

public QBEvent()

QBEvent

public QBEvent(int id)

Method Detail

getMessage

public java.lang.String getMessage()

setMessage

public void setMessage(java.lang.String message)

Event message

setMessage

public void setMessage(java.util.HashMap<java.lang.String,java.lang.Object> data)

getGSMMessage

public java.lang.String getGSMMessage()

getAPNSMessage

public java.lang.String getAPNSMessage()

getUserTagsAny

public <any> getUserTagsAny()

setUserTagsAny

public void setUserTagsAny(<any> userTagsAny)

Recipients tags - list of user tags. Recipients (users) must have at LEAST ONE tag that specified in list.

getUserTagsAll

public <any> getUserTagsAll()

setUserTagsAll

public void setUserTagsAll(<any> userTagsAll)

Recipients tags - list of user tags. Recipients (users) must exactly have ONLY ALL tags that specified in list.

getUserTagsExclude

public <any> getUserTagsExclude()

setUserTagsExclude

public void setUserTagsExclude(<any> userTagsExclude)

Recipients tags - list of user tags. Recipients (users) mustn't have tags that specified in list.

getUserIds

public <any> getUserIds()

setUserIds

public void setUserIds(<any> userIds)

Recipients - list of user ids

addUserIds

public void addUserIds(java.lang.Integer... ids)

setEnvironment

public void setEnvironment(QBEnvironment environment)

getEnvironment

public QBEnvironment getEnvironment()

isActive

public java.lang.Boolean isActive()

setActive

public void setActive(java.lang.Boolean active)

Event state. If you want to send specific notification more than once - just edit Event & set this field to 'YES', Then push will be send immediately, without creating a new one Event.

Parameters:

active - state

getApplicationId

public java.lang.Integer getApplicationId()

setApplicationId

public void setApplicationId(java.lang.Integer applicationId)

getDate

public java.lang.Integer getDate()

The date of the event when it'll fire. The date of the event. Not required if the 'event_type' = 'one_shot' or 'multi_shot' Required if the 'event_type' = 'fixed_date' or 'period_date'

setDate

public void setDate(java.lang.Integer date)

getEndDate

public java.lang.Integer getEndDate()

setEndDate

public void setEndDate(java.lang.Integer endDate)

Date of completion of the event. Can't be less than the 'date'.

getType

public QBEventType getType()

setType

public void setType(QBEventType type)

Event type

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

The name of the event. Service information. Only for the user.

getOccuredCount

public java.lang.Integer getOccuredCount()

setOccuredCount

public void setOccuredCount(java.lang.Integer occuredCount)

Event's occurred count

getPeriod

public java.lang.Integer getPeriod()

setPeriod

public void setPeriod(java.lang.Integer period)

he period of the event in seconds. Possible values: 86400 (1 day) , 604800 (1 week), 2592000 (1 month), 31557600 (1 year)

getUserId

public java.lang.Integer getUserId()

setUserId

public void setUserId(java.lang.Integer userId)

sender ID

getNotificationChannel

public QBNotificationChannel getNotificationChannel()

setNotificationChannel

public void setNotificationChannel(QBNotificationChannel notificationChannel)

getNotificationType

public QBNotificationType getNotificationType()

setNotificationType

public void setNotificationType(QBNotificationType notificationType)

Notification type: push, email, request or pull

getPushType

public QBPushType getPushType()

setPushType

public void setPushType(QBPushType pushType)

getMessageEncoded

public java.lang.String getMessageEncoded()

copyFieldsTo

public void copyFieldsTo(QBEntity entity)

Description copied from class: QBEntity

Copy the data of all fields to another instance

Overrides:

copyFieldsTo in class QBEntity

Parameters:

entity - receiver instance

toString

public java.lang.String toString()

Overrides:

toString in class QBEntity