Predictive Search Algorithms API
Changes in Predictive Search Algorithms API documentation
| Version |
Date |
Status |
|
1.0
|
23.9.2009
|
Approved
|
Changes
No changes in the header files.
Purpose
The Predictive Search Algorithms API enables the adding of new search algorithms
to the Predictive Search framework.
Constraints
This API is valid for all platforms running on Symbian 9.3 or later.
Classification and release information
This API is a domain API and was first published in S60 release 3.2. This
document is valid from S60 release 3.2 onwards.
Emulator support
This API is supported in the WINS/WINSCW emulator environment, with the
following exceptions:
API description
The Predictive Search Algorithms API enables the adding of new search algorithms
to the Predictive Search framework. Each search algorithm is implemented as
an ECOM plug-in and needs to be compliant to the interface definition of
CPcsPlugin.
Use cases
The most common use cases of the Predictive Search Algorithms API are listed
below.
API class structure
The API class structure of the Predictive Search Algorithms API is shown
below.
Related APIs
Using the Predictive Search Algorithms API
Implement a search algorithm plug-in
The following section describes the steps of how to implement an algorithm
plug-in.
-
The plug-in should inherit from
CPcsPlugin (defined in CPcsPlugin.h ).
The
plug-in should implement the pure virtual functions of this interface. Refer
to Predictive Search Client API Specification for specific details on the
use of these functions.
-
The ECOM Interface UID for
CPcsPlugin is defined in CPcsDefs.h
const TUid KPcsPluginInterfaceUid = { 0x2000B5BD }; .
This interface
UID (
KPcsPluginInterfaceUid ) should be defined under "interface_uid"
in the ECOM resource file of the adapter.
The default search algorithm
implementation is available in
mw\searchengines\psengine\PcsAlgorithm\Algorithm1.
Refer to this for more implementation-specific details.
Related APIs
CPcsPluginKPcsPluginInterfaceUid
Extensions to the API
None.
Limitations of the API
None.
References
|
Predictive Search Client API Specification
|