net.rim.blackberry.api.messagelist
Class ApplicationFolderIntegrationConfig

java.lang.Object
  extended by net.rim.blackberry.api.messagelist.ApplicationFolderIntegrationConfig

public class ApplicationFolderIntegrationConfig
extends Object

Specifies how application folder messages should be integrated.

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 6.0.0

Constructor Summary
Category: Signed ApplicationFolderIntegrationConfig()
          Creates default configuration object with all integration settings set to false.
Category: Signed ApplicationFolderIntegrationConfig(boolean messageListIntegration)
          Creates configuration object based on message list integration setting.
Category: Signed ApplicationFolderIntegrationConfig(boolean messageListIntegration, boolean homeScreenIntegration, ApplicationDescriptor uiApplication)
          Creates configuration object based on message list and home screen integration settings.
 
Method Summary
Category: Signed  ServiceRecord getServiceRecord()
          Returns mailbox service record where application messages will be integrated
Category: Signed  ApplicationDescriptor getUiApplication()
          Returns UI application that manages folder messages.
Category: Signed  boolean isHomeScreenIntegration()
          Returns home screen integration setting
Category: Signed  boolean isMessageListIntegration()
          Returns unified message list integration setting
Category: Signed  void setHomeScreenIntegration(boolean homeScreenIntegration)
          Sets home screen integration setting.
Category: Signed  void setMessageListIntegration(boolean messageListIntegration)
          Sets unified message list integration setting
Category: Signed  void setMessageListIntegration(boolean unifiedView, ServiceRecord mailbox)
          Sets unified message list integration settings based on the given mailbox service record.
Category: Signed  void setServiceRecord(ServiceRecord serviceRecord)
          Sets mailbox service record where application messages will be integrated.
Category: Signed  void setUiApplication(ApplicationDescriptor uiApplication)
          Set UI application that manages folder messages.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 



Constructor Detail

ApplicationFolderIntegrationConfig

public ApplicationFolderIntegrationConfig()
Creates default configuration object with all integration settings set to false.

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 6.0.0

ApplicationFolderIntegrationConfig

public ApplicationFolderIntegrationConfig(boolean messageListIntegration)
Creates configuration object based on message list integration setting. In some cases it is not desirable to integrate folder messages, for example, application may manage Junk or SPAM type of messages and prefer to hide them by default. Such messages will be accessible through [View Folder] menu only in the unified message list.

Parameters:
messageListIntegration - defines whether folder messages should be integrated with unified message list
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 6.0.0

ApplicationFolderIntegrationConfig

public ApplicationFolderIntegrationConfig(boolean messageListIntegration,
                                          boolean homeScreenIntegration,
                                          ApplicationDescriptor uiApplication)
Creates configuration object based on message list and home screen integration settings.

Parameters:
messageListIntegration - defines whether folder messages should be integrated with unified message list
homeScreenIntegration - defines whether folder messages should be integrated with home screen
uiApplication - defines UI application that manages messages; the application will be started automatically when user selects group of messages on the home screen
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 6.0.0


Method Detail

isMessageListIntegration

public boolean isMessageListIntegration()
Returns unified message list integration setting

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 6.0.0

setMessageListIntegration

public void setMessageListIntegration(boolean messageListIntegration)
Sets unified message list integration setting

Parameters:
messageListIntegration - defines whether folder messages should be integrated with unified message list
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 6.0.0

setMessageListIntegration

public void setMessageListIntegration(boolean unifiedView,
                                      ServiceRecord mailbox)
Sets unified message list integration settings based on the given mailbox service record.

The message list application may have different views. The 'unified' view combines all types of messages into the same list including email messages from different mailboxes, SMS and MMS messages, etc. The mailbox also may have filtered views that display email messages belonging to a specific email mailbox. For messages integration into such filtered message views, applications must specify a mailbox service record. Note that this type of integration should occur only when application messages are linked to the email service, for example, represent a system messages about the specified mailbox.

Parameters:
unifiedView - defines whether folder messages should appear in the unified message list that combines all messages
mailbox - specifies a mailbox where application messages should be integrated.
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 7.0.0

isHomeScreenIntegration

public boolean isHomeScreenIntegration()
Returns home screen integration setting

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 6.0.0

setHomeScreenIntegration

public void setHomeScreenIntegration(boolean homeScreenIntegration)
Sets home screen integration setting. If folder messages to be integrated with home screen then the application should specify application descriptor for its UI module.

Parameters:
homeScreenIntegration - defines whether folder messages should be integrated with home screen
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 6.0.0

getUiApplication

public ApplicationDescriptor getUiApplication()
Returns UI application that manages folder messages. The application will be started automatically when user selects group of new messages on the home screen.

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 6.0.0

setUiApplication

public void setUiApplication(ApplicationDescriptor uiApplication)
Set UI application that manages folder messages. The application will be started automatically when user selects group of new messages on the home screen.

Parameters:
uiApplication - descriptor for the UI application
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 6.0.0

getServiceRecord

public ServiceRecord getServiceRecord()
Returns mailbox service record where application messages will be integrated

Returns:
service record if specified, NULL otherwise
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 7.0.0

setServiceRecord

public void setServiceRecord(ServiceRecord serviceRecord)
Sets mailbox service record where application messages will be integrated.

Parameters:
serviceRecord - specifies a mailbox where application messages should be integrated
See Also:
ApplicationFolderIntegrationConfig.setMessageListIntegration(boolean, ServiceRecord)
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 7.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