net.rim.blackberry.api.mail.event
Class FolderEvent

java.lang.Object
  extended by net.rim.blackberry.api.mail.event.MailEvent
      extended by net.rim.blackberry.api.mail.event.FolderEvent

public class FolderEvent
extends MailEvent

Encapsulates folder events.

This class signals addition or removal of messages from a folder, and creation or deletion of messages.

Note: It is not possible to intercept a message during transmission. Removal of a Message does not affect data that has already been sent from the handheld.

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 3.6.0

Field Summary
Category: Signed static int FOLDER_CREATED
          A folder was added to the service.
Category: Signed static int FOLDER_DELETED
          A folder was removed from the service.
Category: Signed static int FOLDER_UPDATED
          A folder was updated from the service.
Category: Signed static int MESSAGE_ADDED
          Messages were added to the folder.
Category: Signed static int MESSAGE_REMOVED
          Messages were removed from the folder.
 
Constructor Summary
Category: Signed FolderEvent(Folder folder, int type, Message m)
          Creates a new FolderEvent instance.
 
Method Summary
Category: Signed  void dispatch(Object listener)
          Dispatches this event to provided listener.
Category: Signed  Message getMessage()
          Retrieves the message that was added or removed.
Category: Signed  int getType()
          Returns the type of this event.
Category: Signed  String toString()
          Retrieves string form of this mail event.
 
Methods inherited from class net.rim.blackberry.api.mail.event.MailEvent
getSource
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 



Field Detail

MESSAGE_ADDED

public static final int MESSAGE_ADDED
Messages were added to the folder.

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 3.6.0

MESSAGE_REMOVED

public static final int MESSAGE_REMOVED
Messages were removed from the folder.

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 3.6.0

FOLDER_CREATED

public static final int FOLDER_CREATED
A folder was added to the service.

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.0.0

FOLDER_DELETED

public static final int FOLDER_DELETED
A folder was removed from the service.

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.0.0

FOLDER_UPDATED

public static final int FOLDER_UPDATED
A folder was updated from the service.

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.0.0


Constructor Detail

FolderEvent

public FolderEvent(Folder folder,
                   int type,
                   Message m)
Creates a new FolderEvent instance.

Parameters:
folder - Folder affected by the event.
type - Type of event: FolderEvent.MESSAGE_ADDED, FolderEvent.MESSAGE_REMOVED, FolderEvent.FOLDER_CREATED, or FolderEvent.FOLDER_DELETED.
m - Message added or removed; only for MESSAGE_ADDED and MESSAGE_REMOVED events, otherwise provide null.
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 3.6.0


Method Detail

dispatch

public void dispatch(Object listener)
Dispatches this event to provided listener.

Specified by:
dispatch in class MailEvent
Parameters:
listener - Listener to handle this event.
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 3.6.0

getMessage

public Message getMessage()
Retrieves the message that was added or removed.

Returns:
Message if this is a FolderEvent.MESSAGE_ADDED or FolderEvent.MESSAGE_REMOVED event; otherwise, null.
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 3.6.0

getType

public int getType()
Returns the type of this event.

Returns:
type Type of event: FolderEvent.MESSAGE_ADDED, FolderEvent.MESSAGE_REMOVED, FolderEvent.FOLDER_CREATED, or FolderEvent.FOLDER_DELETED.
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 3.6.0

toString

public String toString()
Description copied from class: MailEvent
Retrieves string form of this mail event.

Overrides:
toString in class MailEvent
Returns:
Null; sub-classes should override this method to provide specific functionality.
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.0.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.