| class MCFContextSourceUpgrade |
Context Source Upgrade API.
RAM based context source settings (configurations) are dynamically added and upgraded via this interface. RAM based settings never hide nor upgrage ROM based settings.
CheckValidity is first called for RAM based settings before they are given to the plugin. The plugin should check that the settings are valid. It may also check client's permission to install the settings, if that is appropriate. CheckValidity is called when new settings are installed or the settings upgrade older ones. Note that the list of settings given for the validity check should not be stored by the plugin.
UpdateSettingsL is called if the call to CheckValidity returned KErrNone or RAM based settings have been uninstalled. UpdateSettingsL includes all current settings for the plugin. The plugin must take the ownership of the settings before calling any code that might leave. Leaving for other reason than out of memory is not recommended because the settings are already stored by Context Framework, and thus the same list of setting block will be provided to the source plugin during next start-up of Context Framework.
| Public Member Functions | |
|---|---|
| TInt | CheckValidity ( RThread &, const CCFContextSourceSettingArray &) |
| void | UpdateSettingsL ( CCFContextSourceSettingArray *) |
| Protected Member Functions | |
|---|---|
| ~MCFContextSourceUpgrade () | |
| TInt | CheckValidity | ( | RThread & | aClientThread, |
| const CCFContextSourceSettingArray & | aSettingList | |||
| ) | [pure virtual] | |||
Checks setting validity. The settings are either new or upgrading existing RAM based settings. The source plugin should check that the settings are valid (correct attributes and parameters) and if necessary, check client's permission to install the settings (security).
| RThread & aClientThread | Client thread installing new or upgrading existing RAM based settings. |
| const CCFContextSourceSettingArray & aSettingList | List of setting blocks, either new settings or settings upgrading older settings from the same client. Note that these settings should only be referenced for possible security check needs, they are not to be copied by the plugin. |
| void | UpdateSettingsL | ( | CCFContextSourceSettingArray * | aSettingList | ) | [pure virtual] |
Updates complete set of settings for the context source. All current setting blocks defined with the plugin name in the XML settings files will be given in an array. Called if CheckSecurity has succeeded when installing new or upgrading RAM based settings, or RAM based settings have been uninstalled. Ownership of the settings is transferred to the plug-in who should take it before calling any code that might leave.
| CCFContextSourceSettingArray * aSettingList | List of setting blocks, ownership is transferred. Note that the array may be empty (zero setting items) if all RAM based settings have been uninstalled and the source does not have any ROM based settings. However, the souce plugin has the ownership (responsibility) of the array. |
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.