com.atlassian.confluence.util.message
Interface MessageManager

All Known Implementing Classes:

DefaultMessageManager

public interface MessageManager

Manages messages to display in pages

Method Summary

void	addMessage(Message message) Add a global message
void	addMessage(java.lang.String spaceKey, Message message) Add a space message
void	addMessage(java.lang.String spaceKey, java.lang.String username, Message message) Deprecated. since 2.9
java.util.List	getMessages() Gets all global messages
java.util.List	getMessages(java.lang.String spaceKey) Get all messages for a given space
java.util.List	getMessages(java.lang.String spaceKey, java.lang.String user) Deprecated. since 2.9
void	removeMessage(java.lang.String spaceKey, java.lang.String id) Removes a message

Method Detail

addMessage

void addMessage(Message message)

Add a global message

Parameters:

message - The message

addMessage

void addMessage(java.lang.String spaceKey,
                java.lang.String username,
                Message message)

Deprecated. since 2.9

Add a message specific to a space and/or user

Parameters:

spaceKey - The space key

username - The user name

message - The message

See Also:

addMessage(String, Message)

addMessage

void addMessage(java.lang.String spaceKey,
                Message message)

Add a space message

Parameters:

message - The message

getMessages

java.util.List getMessages(java.lang.String spaceKey,
                           java.lang.String user)

Deprecated. since 2.9

Get all messages for a given space and/or user, including global messages

Parameters:

spaceKey - The space key

user - The user name

Returns:

A list of relevant Message objects

See Also:

addMessage(String, Message)

getMessages

java.util.List getMessages(java.lang.String spaceKey)

Get all messages for a given space

Parameters:

spaceKey -

Returns:

getMessages

java.util.List getMessages()

Gets all global messages

Returns:

A list of global Message objects

removeMessage

void removeMessage(java.lang.String spaceKey,
                   java.lang.String id)

Removes a message

Parameters:

id - The message id

spaceKey - The space key