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

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





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.