Phonebook 2 xSP View Activation API Specification DocumentChanges in Phonebook 2 xSP View Activation API documentation
Changes in Phonebook 2 xSP View Activation API
PurposePhonebook 2 xSP View Activation API serves two purposes. The first one is to enable external applications to bring xSP extension plug-in views to front, i.e. opening Phonebook 2 to a certain xSP extension view. The second one is to enable getting of xSP extension view related data. API descriptionThe Phonebook 2 xSP View Activation API is a Library API that is provided for opening Phonebook 2 to a certain xSP extension view and getting xSP view related data. Primarily, the API enables the developer to summon a view from his xSP extension plug-in by identifying the plug-in UID and the view ID. The standard view activation mechanism cannot be used with xSP extensions, as a methodology called view mapping is used with them. In practise, view mapping means that the xSP developer does not know the real IDs of his xSP extension views as they are assigned runtime at the xSP extension loading phase. Phonebook 2 xSP View Activation API attaches to the xSP Extension Manager component that handles the view mapping and thus the xSP developer known view ID can be used in an API call. Technically, Phonebook 2 xSP View Activation API is a client-server interface. Through the client-server interface the xSP view related data is transferred in a form of descriptor. The Phonebook 2 xSP View Activation API provides means to transform the data from an object to a descriptor form and vice versa. Use casesPhonebook 2 xSP View Activation API has two functions. The first one is to launch Phonebook 2 to a certain xSP extension view. This can be done either synchronously or asynchronously with several parameter combinations, so these two cases form the use cases of this API. The second one is to get xSP extension view related data. This can be done synchronously or asynchronously. API class structureThe Phonebook 2 xSP View Activation API class
structure is simple, as the whole API consists of two classes. The first class,
Related APIs
Using the Phonebook 2 xSP View Activation API
Example use case: synchronous view launchSynchronous view launch is a very simple operation as it consists of only one method call to the API. The handle to API does not have to be initialized in any specific way: The activation call in basic form contains only the xSP extension plug-in UID and the ID of the view to be brought to front: There exists also a version of activation call that takes the Phonebook 2 view state as parameter and can thus be used to configure the initial looks of the view, for example which contact field index has the focus: Example use case: asynchronous view launchAsynchronous
view launch differs from the synchronous one in the following ways: the operation
requires separate
When
using the asynchronous API, the
Related APIs
Example use case: getting xSP view related dataGetting xSP view related data synchronously requires a set of procedures: getting the total amount of xSP tab-views, asking for needed descriptor length, allocating buffer space and getting the view data in a descriptor form, and, finally, unpacking the data. It is also possible to get xSP view related data asynchronously by using active objects and asynchronous versions of above described functions. Error handlingSome of the methods leave
in case of an error situation. Normal error handling practices should be used,
e.g. using the cleanup stack and the
Related APIs
Related APIs
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies). All rights reserved. License: EPL
|
