net.rim.device.api.io.messaging
Interface InboundDestinationConfiguration


public interface InboundDestinationConfiguration

InboundDestinationConfiguration encapsulates all the parameters that configure a receiver Destination created with DestinationFactory class.

Since:
BlackBerry API 6.0.0

Field Summary
static byte CONFIG_TYPE_BES
          BES configuration type (for BES messages)
static byte CONFIG_TYPE_BPS
          BPS configuration type (for BPS messages)
static byte CONFIG_TYPE_IPC
          IPC configuration type (for Local messages)
 
Method Summary
 byte getType()
          Retrieve the configuration type
 boolean isAutoStart()
          Return whether or not this application will be auto-started when messages are delivered to this destination
 boolean isExclusiveMode()
          Attempts by other applications to create receiver destination for this URI will throw an exception.
 boolean isPersistentMode()
          Indicates whether or not the Communication API will store Message objects for this destination in persistent storage after they have been received.
 



Field Detail

CONFIG_TYPE_IPC

static final byte CONFIG_TYPE_IPC
IPC configuration type (for Local messages)

See Also:
Constant Field Values
Since:
BlackBerry API 6.0.0

CONFIG_TYPE_BES

static final byte CONFIG_TYPE_BES
BES configuration type (for BES messages)

See Also:
Constant Field Values
Since:
BlackBerry API 6.0.0

CONFIG_TYPE_BPS

static final byte CONFIG_TYPE_BPS
BPS configuration type (for BPS messages)

See Also:
Constant Field Values
Since:
BlackBerry API 6.0.0


Method Detail

isAutoStart

boolean isAutoStart()
Return whether or not this application will be auto-started when messages are delivered to this destination

Returns:
true if application will be auto-started on message receipt. false otherwise.
Since:
BlackBerry API 6.0.0

isExclusiveMode

boolean isExclusiveMode()
Attempts by other applications to create receiver destination for this URI will throw an exception.

Returns:
true if enabled
Since:
BlackBerry API 6.0.0

isPersistentMode

boolean isPersistentMode()
Indicates whether or not the Communication API will store Message objects for this destination in persistent storage after they have been received. If "Persistence Mode" is true, messages are persisted on the device and will survive device reboot. If "Persistent Mode" is false, all received messages are stored in the memory and will be lost on device reboot if application didn't have an opportunity to process them. The functionality for "Persistent Mode ON" is not supported in BlackBerry Java SDK 6.0 and the method will always return "false".

Returns:
true if enabled; false otherwise.
Since:
BlackBerry API 6.0.0

getType

byte getType()
Retrieve the configuration type

Returns:
configuration type
Since:
BlackBerry API 6.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