java.lang.Object
- org.exoplatform.commons.api.notification.model.NotificationInfo

public class NotificationInfo
extends Object

Field Summary

Fields
Modifier and Type Field Description

static String FOR_ALL_INTERNAL_USER

static String FOR_ALL_USER

static String PREFIX_ID

Constructor Summary

Constructors
Constructor Description

NotificationInfo()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`NotificationInfo`	`clone()`
`NotificationInfo`	`clone(boolean isNew)`
`NotificationInfo`	`end()`
`boolean`	`equals(Object o)`
`NotificationInfo`	`exclude(String excludedUserId)`
`NotificationInfo`	`exclude(List<String> excludedUsersIds)`
`static String`	`generate()`
`String[]`	`getArrayOwnerParameter()`
`ChannelKey`	`getChannelKey()`	Gets the channel key of the notification
`Calendar`	`getDateCreated()`
`List<String>`	`getExcludedUsersIds()`
`String`	`getFrom()`
`String`	`getId()`
`static org.exoplatform.services.idgenerator.IDGeneratorService`	`getIdGeneratorService()`
`PluginKey`	`getKey()`
`long`	`getLastModifiedDate()`	Get the last modified date
`int`	`getOrder()`
`Map<String,String>`	`getOwnerParameter()`
`String[]`	`getSendToDaily()`
`List<String>`	`getSendToUserIds()`
`String[]`	`getSendToWeekly()`
`String`	`getTitle()`	Gets the title of the notification
`String`	`getTo()`
`String`	`getValueOwnerParameter(String key)`
`int`	`hashCode()`
`static NotificationInfo`	`instance()`
`boolean`	`isExcluded(String userId)`
`boolean`	`isOnPopOver()`
`boolean`	`isRead()`
`boolean`	`isResetOnBadge()`
`boolean`	`isSendAll()`
`boolean`	`isSendAllInternals()`
`boolean`	`isUpdate()`
`NotificationInfo`	`key(String id)`
`NotificationInfo`	`key(PluginKey key)`
`NotificationInfo`	`removeOnSendToDaily(String userId)`
`NotificationInfo`	`removeOnSendToWeekly(String userId)`
`void`	`setChannelKey(ChannelKey channelKey)`	Sets the channel of the notification
`NotificationInfo`	`setDateCreated(Calendar dateCreated)`
`NotificationInfo`	`setFrom(String from)`
`NotificationInfo`	`setId(String id)`
`NotificationInfo`	`setLastModifiedDate(long lastModifiedDate)`
`NotificationInfo`	`setLastModifiedDate(Calendar lastModifiedDate)`
`NotificationInfo`	`setOnPopOver(boolean isOnPopOver)`
`NotificationInfo`	`setOrder(int order)`
`NotificationInfo`	`setOwnerParameter(Map<String,String> ownerParameter)`
`NotificationInfo`	`setRead(boolean read)`
`NotificationInfo`	`setResetOnBadge(boolean resetOnBadge)`
`NotificationInfo`	`setSendAll(boolean isSendAll)`
`NotificationInfo`	`setSendAllInternals(boolean isSendAllInternals)`
`NotificationInfo`	`setSendToDaily(String userId)`
`NotificationInfo`	`setSendToDaily(String[] userIds)`
`NotificationInfo`	`setSendToWeekly(String userId)`
`NotificationInfo`	`setSendToWeekly(String[] userIds)`
`NotificationInfo`	`setTitle(String title)`	Sets the title of the notification
`NotificationInfo`	`setTo(String to)`
`NotificationInfo`	`setUpdate(boolean isUpdate)`
`NotificationInfo`	`to(String sendToUserId)`
`NotificationInfo`	`to(List<String> sendToUserIds)`
`String`	`toString()`
`NotificationInfo`	`with(String key, String value)`

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

Field Detail
- PREFIX_ID
```
public static final String PREFIX_ID
```
  See Also:
  
  Constant Field Values
- FOR_ALL_USER
```
public static final String FOR_ALL_USER
```
  See Also:
  
  Constant Field Values
- FOR_ALL_INTERNAL_USER
```
public static final String FOR_ALL_INTERNAL_USER
```
  See Also:
  
  Constant Field Values

Constructor Detail
- NotificationInfo
```
public NotificationInfo()
```

Method Detail

instance

public static NotificationInfo instance()

getId
```
public String getId()
```

setId

public NotificationInfo setId(String id)

setSendAll

public NotificationInfo setSendAll(boolean isSendAll)

isSendAll
```
public boolean isSendAll()
```

isSendAllInternals
```
public boolean isSendAllInternals()
```

setSendAllInternals

public NotificationInfo setSendAllInternals(boolean isSendAllInternals)

isUpdate
```
public boolean isUpdate()
```

setUpdate

public NotificationInfo setUpdate(boolean isUpdate)

getKey
```
public PluginKey getKey()
```

key

public NotificationInfo key(PluginKey key)

key

public NotificationInfo key(String id)

getFrom
```
public String getFrom()
```

setFrom

public NotificationInfo setFrom(String from)

getTitle
```
public String getTitle()
```
Gets the title of the notification

Returns:

setTitle
```
public NotificationInfo setTitle(String title)
```
Sets the title of the notification

Parameters:

title -

getChannelKey
```
public ChannelKey getChannelKey()
```
Gets the channel key of the notification

Returns:

setChannelKey
```
public void setChannelKey(ChannelKey channelKey)
```
Sets the channel of the notification

Parameters:

channelKey -

getTo
```
public String getTo()
```
Returns:

the to

setTo

public NotificationInfo setTo(String to)

Parameters:: to - the to to set

getOrder
```
public int getOrder()
```
Returns:

the order

setOrder

public NotificationInfo setOrder(int order)

Parameters:: order - the order to set

getSendToUserIds

public List<String> getSendToUserIds()

to

public NotificationInfo to(List<String> sendToUserIds)

getExcludedUsersIds

public List<String> getExcludedUsersIds()

to

public NotificationInfo to(String sendToUserId)

exclude

public NotificationInfo exclude(List<String> excludedUsersIds)

exclude

public NotificationInfo exclude(String excludedUserId)

isExcluded

public boolean isExcluded(String userId)

getOwnerParameter

public Map<String,String> getOwnerParameter()

Returns:: the ownerParameter

getValueOwnerParameter

public String getValueOwnerParameter(String key)

Returns:: the value of ownerParameter

getArrayOwnerParameter
```
public String[] getArrayOwnerParameter()
```
Returns:

the array ownerParameter

setOwnerParameter

public NotificationInfo setOwnerParameter(Map<String,String> ownerParameter)

Parameters:: ownerParameter - the ownerParameter to set

with

public NotificationInfo with(String key,
                             String value)

Parameters:: key - the ownerParameter key to set; value - the ownerParameter value to set

end
```
public NotificationInfo end()
```

getLastModifiedDate
```
public long getLastModifiedDate()
```
Get the last modified date

Returns:

setLastModifiedDate

public NotificationInfo setLastModifiedDate(Calendar lastModifiedDate)

Parameters:: lastModifiedDate -

setLastModifiedDate

public NotificationInfo setLastModifiedDate(long lastModifiedDate)

Parameters:: lastModifiedDate -

getDateCreated
```
public Calendar getDateCreated()
```

setDateCreated

public NotificationInfo setDateCreated(Calendar dateCreated)

isOnPopOver
```
public boolean isOnPopOver()
```

setOnPopOver

public NotificationInfo setOnPopOver(boolean isOnPopOver)

getSendToDaily
```
public String[] getSendToDaily()
```
Returns:

the sendToDaily

setSendToDaily
```
public NotificationInfo setSendToDaily(String[] userIds)
```
Parameters:

userIds - the list userIds to set for sendToDaily

setSendToDaily
```
public NotificationInfo setSendToDaily(String userId)
```
Parameters:

userId - the userId to add into sendToDaily

removeOnSendToDaily
```
public NotificationInfo removeOnSendToDaily(String userId)
```
Parameters:

userId - the userId to remove into sendToDaily

getSendToWeekly
```
public String[] getSendToWeekly()
```
Returns:

the sendToWeekly

setSendToWeekly
```
public NotificationInfo setSendToWeekly(String[] userIds)
```
Parameters:

userIds - the list userIds to set for sendToWeekly

setSendToWeekly
```
public NotificationInfo setSendToWeekly(String userId)
```
Parameters:

userId - the userId to add into sendToWeekly

removeOnSendToWeekly
```
public NotificationInfo removeOnSendToWeekly(String userId)
```
Parameters:

userId - the userId to remove into sendToWeekly

isResetOnBadge
```
public boolean isResetOnBadge()
```

setResetOnBadge

public NotificationInfo setResetOnBadge(boolean resetOnBadge)

isRead
```
public boolean isRead()
```

setRead

public NotificationInfo setRead(boolean read)

equals
```
public boolean equals(Object o)
```
Overrides:

equals in class Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

toString
```
public String toString()
```
Overrides:

toString in class Object

clone
```
public NotificationInfo clone()
```
Overrides:

clone in class Object

clone

public NotificationInfo clone(boolean isNew)

getIdGeneratorService

public static org.exoplatform.services.idgenerator.IDGeneratorService getIdGeneratorService()

generate
```
public static String generate()
```

Modifier and Type	Field	Description
`static String`	`FOR_ALL_INTERNAL_USER`
`static String`	`FOR_ALL_USER`
`static String`	`PREFIX_ID`

Class NotificationInfo

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

PREFIX_ID

FOR_ALL_USER

FOR_ALL_INTERNAL_USER

Constructor Detail

NotificationInfo

Method Detail

instance

getId

setId

setSendAll

isSendAll

isSendAllInternals

setSendAllInternals

isUpdate

setUpdate

getKey

key

key

getFrom

setFrom

getTitle

setTitle

getChannelKey

setChannelKey

getTo

setTo

getOrder

setOrder

getSendToUserIds

to

getExcludedUsersIds

to

exclude

exclude

isExcluded

getOwnerParameter

getValueOwnerParameter

getArrayOwnerParameter

setOwnerParameter

with

end

getLastModifiedDate

setLastModifiedDate

setLastModifiedDate

getDateCreated

setDateCreated

isOnPopOver

setOnPopOver

getSendToDaily

setSendToDaily

setSendToDaily

removeOnSendToDaily

getSendToWeekly

setSendToWeekly

setSendToWeekly

removeOnSendToWeekly

isResetOnBadge

setResetOnBadge

isRead

setRead

equals

hashCode

toString

clone

clone

getIdGeneratorService

generate