Welcome to the official BlackBerry Support Community Forums.

This is your resource to discuss support topics with your peers, and learn from each other.

inside custom component

Java Development

How to integrate with the Unified Search Framework

by Retired on ‎08-03-2010 11:21 AM - edited on ‎09-20-2010 04:57 PM by Retired (6,252 Views)

This article applies to the BlackBerry® APIs 6.0.


The Unified Search Framework is a new feature part of BlackBerry® Device Software 6, which allows a BlackBerry device user to query on device and remote application data. The Unified Search API provides the following two mechanisms for third-party applications to plug in to the Unified Search Framework:


  • Click to search integration
  • Type to search integration



CLICK-TO-SEARCH integration

The ExternalSearchProvider interface enables the implementing application to receive queries through the Unified Search Framework. The registering application can then peform the search using its own search service and display the results within its own interface.

This type of integration is recommended for existing search engines or remote network-based searches. Searches are performed once the user clicks on the icon for the search provider.


TYPE-TO-SEARCH integration

The Unified Search Service maintains an index of all searchable content on a BlackBerry device. An application  must perform the following tasks to ensure its data is searchable by the framework:


  • Prepare application data by encapsulating it within a SearchableEntity class and specifying how users will interact with your data when it appears within search results (UiActions).
  • Register an entity management class by implementing the EntityBasedSearchable interface.
  • Notify the Unified Search Service of changes to your data using the AppContentManager class.
  • Listen for responses using the AppContentListener interface after the framework has processed the changes you requested through the AppContentManager (Optional).


This type of integration is recommended for applications that would like to index their on-device data using the Unified Search Framework. Searches are performed and results returned as the user types a query.


For more details, refer to the Unified Search Integration Guide.

Users Online
Currently online: 23 members 1,317 guests
Please welcome our newest community members: