net.rim.device.api.notification
Interface NotificationsConstants

All Known Subinterfaces:
Consequence, NotificationsEngineListener
All Known Implementing Classes:
NotificationsManager

public interface NotificationsConstants

The NotificationsConstants interface provides constant data values for use with notification functionality.

There are a number of different sets of constants defined by this interface:

a) CRITICAL, SENSITIVE, IMPORTANT, CASUAL, DEFAULT_LEVEL refer to UI interactivity levels at which an application can register itself with the notifications framework. New events are queued up according to these levels, which means that some events may never actually be seen by the user. This could possibly happen if we have an event at a high priority which demands user response (e.g., a calendar event) and a transient event at a lower level (e.g., a notification that a new chess move was received) that is only meant to be seen for a set amount of time and disappears before the calendar event is handled by the user.

b) OUT_OF_HOLSTER_TRIGGER, MANUAL_TRIGGER refer to how the events are triggered. Out-of-holster events are triggered automatically by the user action of pulling the device out of the holster. For example, incoming email messages that arrive while the device is holstered. Manually-triggered events need to be set off by the interested application. Calendar and alarm events are good examples.

c) OUT_OF_HOLSTER_ENGINE_STATE, IN_HOLSTER_ENGINE_STATE refer to the internal state in which the notification engine currently resides. This should be of interest to implementors of NotificationEngineListener because it might help the listeners with their event-handling logic to know which state the engine is currently in.

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 long CALLERID_ADDRESSCARD_UID
          Context key to indicate addresscard mapped to incoming message/call
Category: Signed static int CASUAL
          Casual notification level.
Category: Signed static int CONTINUOUS_REPEAT
          Repeat the alert continuously.
Category: Signed static int CRITICAL
          Critical notification level.
Category: Signed static long CUSTOM_TUNE_NAME
          Context key to indicate there is a custom tune for this incoming message/call
Category: Signed static int DEFAULT_LEVEL
          Default notification level.
Category: Signed static int FORCED
          Forced Notification
Category: Signed static int FORCE_NO_REPEAT_NOTIFICATIONS_FLAG
          Flag for forcing repeat notifications to be turned off.
Category: Signed static int IMPORTANT
          Important notification level.
Category: Signed static int IN_HOLSTER_ENGINE_STATE
          In-holster engine state.
Category: Signed static int MANUAL_TRIGGER
          Manual event trigger.
Category: Signed static long NOTIFICATION_LEVEL_KEY
          Context key to indicate level of notifiation
Category: Signed static long NOTIFICATION_PRIVATE_FLAG_KEY
          Context key to indicate repeat notifications
Category: Signed static long NOTIFICATION_REPEAT_COUNT
          Context KEY to indicate repeat notifications
Category: Signed static long NOTIFICATION_REPEAT_DELAY
          Context KEY to indicate delay between repeat notifications
Category: Signed static long NO_RELATED_SOURCE
          Constant to indicate there is no related source.
Category: Signed static long NO_SOURCE
          Constant to indicate there is no source.
Category: Signed static int OUT_OF_HOLSTER_ENGINE_STATE
          Out-of-holster engine state.
Category: Signed static int OUT_OF_HOLSTER_TRIGGER
          Out-of-holster event trigger.
Category: Signed static int SENSITIVE
          Sensitive notification level.
Category: Signed static long STOP_CONDITIONS
          Context KEY to indicate stop conditions
 



Field Detail

FORCED

static final int FORCED
Forced Notification

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

CRITICAL

static final int CRITICAL
Critical notification level.

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

SENSITIVE

static final int SENSITIVE
Sensitive notification level.

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

IMPORTANT

static final int IMPORTANT
Important notification level.

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

CASUAL

static final int CASUAL
Casual notification level.

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

DEFAULT_LEVEL

static final int DEFAULT_LEVEL
Default notification level.

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

OUT_OF_HOLSTER_TRIGGER

static final int OUT_OF_HOLSTER_TRIGGER
Out-of-holster event trigger.

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

MANUAL_TRIGGER

static final int MANUAL_TRIGGER
Manual event trigger.

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

OUT_OF_HOLSTER_ENGINE_STATE

static final int OUT_OF_HOLSTER_ENGINE_STATE
Out-of-holster engine state.

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

IN_HOLSTER_ENGINE_STATE

static final int IN_HOLSTER_ENGINE_STATE
In-holster engine state.

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

NOTIFICATION_REPEAT_COUNT

static final long NOTIFICATION_REPEAT_COUNT
Context KEY to indicate repeat notifications

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

NOTIFICATION_REPEAT_DELAY

static final long NOTIFICATION_REPEAT_DELAY
Context KEY to indicate delay between repeat notifications

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

STOP_CONDITIONS

static final long STOP_CONDITIONS
Context KEY to indicate stop conditions

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

NOTIFICATION_LEVEL_KEY

static final long NOTIFICATION_LEVEL_KEY
Context key to indicate level of notifiation

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

NOTIFICATION_PRIVATE_FLAG_KEY

static final long NOTIFICATION_PRIVATE_FLAG_KEY
Context key to indicate repeat notifications

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

CALLERID_ADDRESSCARD_UID

static final long CALLERID_ADDRESSCARD_UID
Context key to indicate addresscard mapped to incoming message/call

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

CUSTOM_TUNE_NAME

static final long CUSTOM_TUNE_NAME
Context key to indicate there is a custom tune for this incoming message/call

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

FORCE_NO_REPEAT_NOTIFICATIONS_FLAG

static final int FORCE_NO_REPEAT_NOTIFICATIONS_FLAG
Flag for forcing repeat notifications to be turned off.

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

NO_RELATED_SOURCE

static final long NO_RELATED_SOURCE
Constant to indicate there is no related source.

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

NO_SOURCE

static final long NO_SOURCE
Constant to indicate there is no source.

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

CONTINUOUS_REPEAT

static final int CONTINUOUS_REPEAT
Repeat the alert continuously. Set _repeatCount to CONTINUOUS_REPEAT in the AlertEngine to play an alert endlessly.

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