com.atlassian.confluence.mail.notification

Class Notification

java.lang.Object

com.atlassian.core.bean.EntityObject

com.atlassian.confluence.core.ConfluenceEntityObject

com.atlassian.confluence.mail.notification.Notification

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class Notification
extends ConfluenceEntityObject

A "Notification" is an email subscription or "watch" on some space. If page and space are set, it's a page notification If just space is set, it's a space notification If neither are set, it's a daily email subscription (Yeah, slightly dodgy, but it works)

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Notification.WatchType A single enum value representing the combination of notification type, page, space and network settings.

Constructor Summary

Constructors

Constructor and Description
Notification()

Method Summary

Methods

Modifier and Type	Method and Description
ContentEntityObject	getContent()
Label	getLabel()
AbstractPage	getPage() Deprecated. since 5.3. Use getContent() instead (and make no assumptions about what type of content is associated here)
ConfluenceUser	getReceiver()
Space	getSpace()
ContentTypeEnum	getType()
java.lang.String	getUserName() Deprecated. since 5.2. User getReceiver() instead.
Notification.WatchType	getWatchType() Returns a single enum value representing the combination of notification type, page, space and network settings.
boolean	isContentNotification()
boolean	isDigest()
boolean	isNetwork() Deprecated. since 5.3. Use isNetworkNotification() instead.
boolean	isNetworkNotification()
boolean	isPageNotification()
boolean	isSpaceNotification()
boolean	isUserChange()
boolean	matchesContentType(AbstractPage page) Returns true if this notification matches the type of the passed content object.
void	setContent(ContentEntityObject content)
void	setDigest(boolean digest)
void	setLabel(Label label)
void	setNetwork(boolean network)
void	setPage(AbstractPage page) Deprecated. since 5.3. Use @setContent instead.
void	setReceiver(ConfluenceUser receiver)
void	setSpace(Space space)
void	setType(ContentTypeEnum type)
void	setUserName(java.lang.String userName) Deprecated. since 5.2. See setReceiver(ConfluenceUser).

Methods inherited from class com.atlassian.confluence.core.ConfluenceEntityObject

getCreator, getCreatorName, getLastModifier, getLastModifierName, getRealClass, isPersistent, setCreator, setCreatorName, setLastModifier, setLastModifierName

Methods inherited from class com.atlassian.core.bean.EntityObject

clone, equals, getCreationDate, getCurrentDate, getId, getLastModificationDate, hashCode, setClock, setCreationDate, setId, setLastModificationDate

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Notification

public Notification()

Method Detail

getPage

public AbstractPage getPage()

Deprecated. since 5.3. Use getContent() instead (and make no assumptions about what type of content is associated here)

setPage

public void setPage(AbstractPage page)

Deprecated. since 5.3. Use @setContent instead.

getUserName

@Deprecated
public java.lang.String getUserName()

Deprecated. since 5.2. User getReceiver() instead.

setUserName

@Deprecated
public void setUserName(java.lang.String userName)

Deprecated. since 5.2. See setReceiver(ConfluenceUser).

Parameters:

userName -

getReceiver

public ConfluenceUser getReceiver()

Since:

5.2

setReceiver

public void setReceiver(ConfluenceUser receiver)

Since:

5.2

getSpace

public Space getSpace()

setSpace

public void setSpace(Space space)

isUserChange

public boolean isUserChange()

isPageNotification

public boolean isPageNotification()

isContentNotification

public boolean isContentNotification()

isSpaceNotification

public boolean isSpaceNotification()

isDigest

public boolean isDigest()

setDigest

public void setDigest(boolean digest)

getType

public ContentTypeEnum getType()

setType

public void setType(ContentTypeEnum type)

isNetworkNotification

public boolean isNetworkNotification()

isNetwork

@Deprecated
public boolean isNetwork()

Deprecated. since 5.3. Use isNetworkNotification() instead.

setNetwork

public void setNetwork(boolean network)

matchesContentType

public boolean matchesContentType(AbstractPage page)

Returns true if this notification matches the type of the passed content object.

getWatchType

public Notification.WatchType getWatchType()

Returns a single enum value representing the combination of notification type, page, space and network settings.

getContent

public ContentEntityObject getContent()

setContent

public void setContent(ContentEntityObject content)

getLabel

public Label getLabel()

setLabel

public void setLabel(Label label)