net.rim.blackberry.api.mail.event
Class StoreEvent
java.lang.Object
net.rim.blackberry.api.mail.event.MailEvent
net.rim.blackberry.api.mail.event.StoreEvent
public class StoreEvent
- extends MailEvent
Indicates that an event has occured on a specified store.
- 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 |
|
static int |
BATCH_OPERATION
Indicates that a batch operation has occurred on this store, such as a bulk delete or
bulk add. |
|
Constructor Summary |
|
StoreEvent(Store store,
int type)
Creates a new StoreEvent instance given the store and event type. |
|
Method Summary |
|
void |
dispatch(Object listener)
Invokes the appropriate method on a listener for this event. |
|
int |
getType()
Returns the type of this event. |
|
String |
toString()
Retrieves string form of this mail event. |
BATCH_OPERATION
public static final int BATCH_OPERATION
- Indicates that a batch operation has occurred on this store, such as a bulk delete or
bulk add.
Users of the API should reconcile the state of all held Message instances, for instance, check for the Message.DELETED flag
indicating the message has been deleted.
- 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
StoreEvent
public StoreEvent(Store store,
int type)
- Creates a new
StoreEvent instance given the store and event type.
- Parameters:
store - The store that published this event.type - Type of event, either MESSAGE_ADDED or MESSAGE_REMOVED.- 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
dispatch
public void dispatch(Object listener)
- Description copied from class:
MailEvent
- Invokes the appropriate method on a listener for this event.
Subclasses should override this method to provide specific
functionality (that is, to dispatch to the appropriate method on the
appropriate listener type).
- 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
getType
public int getType()
- Returns the type of this event.
- Returns:
- Either
MESSAGE_ADDED or MESSAGE_REMOVED. - 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-2011 Research In Motion Limited. 295 Phillip Street, Waterloo, Ontario, Canada, N2L 3W8. All Rights Reserved.
Java is a trademark of Oracle America Inc. in the US and other countries.
Legal