net.rim.blackberry.api.messagelist
Interface ApplicationMessageFolderListener

public interface ApplicationMessageFolderListener

Folder listener that is notified when the user has manipulated one or more application messages in the Messages application. The constants in this interface represent the user actions that trigger a notification.

If the callback notification indicates that more than one application message has been manipulated, the application should call ApplicationMessageFolder.fireReset() instead of individual fire calls (such as fireElementAdded() and fireElementRemoved()) for better performance.

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.6.0

Field Summary
	static int	MESSAGES_MARKED_OLD Performed when the user opens the global message list and views partial message information.
	static int	MESSAGE_DELETED Performed when the user manually deletes messages from the list by pressing the Delete key or through a context menu.
	static int	MESSAGE_MARKED_OPENED Performed when the user manually marks selected messages as opened.
	static int	MESSAGE_MARKED_UNOPENED Performed when the user manually marks selected messages as unopened.

Method Summary
	void	actionPerformed(int action, ApplicationMessage[] messages, ApplicationMessageFolder folder) Called when an action is performed on an ApplicationMessageFolder.

Field Detail

MESSAGE_DELETED

static final int MESSAGE_DELETED

Performed when the user manually deletes messages from the list by pressing the Delete key or through a context menu. Applications don't have to notify the folder that the message was deleted from the collection through the ApplicationMessageFolder.fireElementRemoved(ApplicationMessage) method.

See Also:

Constant Field Values

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.6.0

MESSAGE_MARKED_OPENED

static final int MESSAGE_MARKED_OPENED

Performed when the user manually marks selected messages as opened.

See Also:

Constant Field Values

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.6.0

MESSAGE_MARKED_UNOPENED

static final int MESSAGE_MARKED_UNOPENED

Performed when the user manually marks selected messages as unopened.

See Also:

Constant Field Values

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.6.0

MESSAGES_MARKED_OLD

static final int MESSAGES_MARKED_OLD

Performed when the user opens the global message list and views partial message information. This applies to "new" messages and tells the application that the folder messages were opened in the global message list.

Note that no messages are passed in the second method parameter of ApplicationMessageFolderListener.actionPerformed(int, ApplicationMessage[], ApplicationMessageFolder) method. The array will be empty.

See Also:

ApplicationMessageFolder.fireElementAdded(ApplicationMessage, boolean), Constant Field Values

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 6.0.0

Method Detail

actionPerformed

void actionPerformed(int action,
                     ApplicationMessage[] messages,
                     ApplicationMessageFolder folder)

Called when an action is performed on an ApplicationMessageFolder. The method executes in the application's environment asynchronously after the given action has been performed. If the array of messages contains more than one element, the application should call ApplicationMessageFolder.fireReset() instead of making individual fire method calls that represent individual changes.

If a message was deleted by the user and the folder listener was called back with the ApplicationMessageFolderListener.MESSAGE_DELETED action, there is no need to fire notifications on the folder through ApplicationMessageFolder.fireElementRemoved(ApplicationMessage).

Parameters:

action - Action code specified by one of the constants in this interface.

messages - An underlying message or an array of messages if a bulk operation.

folder - Folder that contains the message(s).

Category:

Signed: This element is only accessible by signed applications. If you intend to use this element, please visit http://www.blackberry.com/go/codesigning to obtain a set of code signing keys. Code signing is only required for applications running on BlackBerry smartphones; development on BlackBerry Smartphone Simulators can occur without code signing.

Since:

BlackBerry API 4.6.0