net.rim.blackberry.api.messagelist
Interface ApplicationMessageFolderListener


public interface ApplicationMessageFolderListener

Folder listener that is notified when an application message or bulk of messages are operated in the folder. Message List component provides generic operations such as messages deletion, marking it opened and others.

If the callback notification results in updating more than one message then the application should call ApplicationMessageFolder.fireReset() instead of individual ApplicationMessageFolder#fireElementAdded(Object) calls 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
Category: Signed static int MESSAGE_DELETED
          Performed when user manually deletes messages from the list by pressing DEL button or through context menu.
Category: Signed static int MESSAGE_MARKED_OPENED
          Performed when user manually marks selected messages or messages prior to selected date as opened
Category: Signed static int MESSAGE_MARKED_UNOPENED
          Performed when user manually marks selected messages as unopened
 
Method Summary
Category: Signed  void actionPerformed(int action, ApplicationMessage[] messages, ApplicationMessageFolder folder)
          This method is called when action is performed on given folder.
 



Field Detail

MESSAGE_DELETED

static final int MESSAGE_DELETED
Performed when user manually deletes messages from the list by pressing DEL button or through context menu. Application don't have to notify folder that the message was deleted from collection through 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 user manually marks selected messages or messages prior to selected date 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 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


Method Detail

actionPerformed

void actionPerformed(int action,
                     ApplicationMessage[] messages,
                     ApplicationMessageFolder folder)
This method is called when action is performed on given folder. 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 then the application should call ApplicationMessageFolder.fireReset() instead of individual ApplicationMessageFolder.fireElementUpdated(ApplicationMessage, ApplicationMessage) methods after updating the messages.

If a message was deleted by user and folder listener was called back with ApplicationMessageFolderListener.MESSAGE_DELETED action then there is no need to fire notifications on folder through one of the fireXXX() methods.

Parameters:
action - action code specified by one of the constants from this interface
messages - an underlying message or array of messages for a bulk operation
folder - folder that contains the message
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





Copyright 1999-2010 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Copyright 1993-2003 Sun Microsystems, Inc. 901 San Antonio Road, Palo Alto, California, 94303, U.S.A. All Rights Reserved.
Copyright 2002-2003 Nokia Corporation All Rights Reserved.
Java is a trademark of Sun Microsystems, Inc.