SHOW Signed

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

java.lang.Object
  |
  +--net.rim.blackberry.api.mail.event.MailEvent
        |
        +--net.rim.blackberry.api.mail.event.FolderEvent

public class FolderEvent

extends MailEvent

Indicates that a message in a folder was added or removed.

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 clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

Since:

JDE 3.6.0

Field Summary

	static int	MESSAGE_ADDED Messages were added to the folder.
	static int	MESSAGE_REMOVED Messages were removed from the folder.

Fields inherited from class net.rim.blackberry.api.mail.event.MailEvent

_source

Constructor Summary

FolderEvent(Folder folder, int type, Message m) Constructor.

Method Summary

	void	dispatch(Object listener) Invokes the appropriate method on a listener for this event.
	Message	getMessage() Retrieves the message that was added or removed.
	int	getType() Returns the type of this event.

Methods inherited from class net.rim.blackberry.api.mail.event.MailEvent

getSource, toString

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.

Since:

JDE 3.6.0

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

MESSAGE_REMOVED

public static final int MESSAGE_REMOVED

Messages were removed from the folder.

Since:

JDE 3.6.0

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

Constructor Detail

FolderEvent

public FolderEvent(Folder folder,
                   int type,
                   Message m)

Constructor.

Parameters:

folder - Folder that is affected by the event.

type - Type of event, either MESSAGE_ADDED or MESSAGE_REMOVED.

m - Message that was added or removed.

Since:

JDE 3.6.0

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

Method Detail

dispatch

public void dispatch(Object listener)

Description copied from class: MailEvent

Invokes the appropriate method on a listener for this event.

Subclasses provide the implementation.

Overrides:

dispatch in class MailEvent

Since:

JDE 3.7.0

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getMessage

public Message getMessage()

Retrieves the message that was added or removed.

Returns:

Message object.

Since:

JDE 3.6.0

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.

getType

public int getType()

Returns the type of this event.

Returns:

Either MESSAGE_ADDED or MESSAGE_REMOVED.

Since:

JDE 3.6.0

Category:

Signed: This element is only accessible by signed clients. If you intend to use this element, please contact RIM to establish the necessary agreements that will allow you to have your COD files signed. Signing is only required for use on the device, development under the JDE can occur without signing the CODs.