MhspsInstallationService Class Reference

class MhspsInstallationService

Part of HSPS Plugin Configuration Management Service APIs. MhspsInstallationService . API-definition for HSPS Plugin Installation Service. HSPS Plugin Installation Service is intended to serve Homescreen as well as S60 legacy applications - expecially the Personalisation Application - with the Homescreen Application Configuartion installation functionality. Implementation of this interface will offer high- and low-level API-functionality. High-level and low-level calls are diffrentiated by their parametrization. High-level parametrization is directed to the be used by applications which need human readable data and offer a user interface. Low-level parametrization is directed to the machine-originated requestors like OTA Push or DM (Device Management) sub-systems where data is not needed to understand semanticly.

Processing a installation task works in asynchronous mode, howvere, synchronous mode is applied everytime the installation is initiated. After checking installation rights and files valididies, hsps Theme Server will allow actual installation. Client application must call actual installation by commencing next phase execution explicitly. First call of installation returns the ODT-header of the teme to be installed. This is to enable previewing information about a theme to be installed. In this point, user can accept or decline the installation. Installation preview feature is useful expecially in OTA-service cases when user acception on theme installation might be selected a a part of user policy settings. A theme can include resources that can be imported to the target system as such like some audio files etc., however, most of the images must be fitted on to the target device's color depth and pixel density. In these cases, the needed conversions will be executed asynchronously on server-side. Asynchronous installation is executed in phases - resource by resource. Installation phases are promoted automaticly, however, client application can control and monitor installation phases, and also cancel installation at any time. If installation is canceled, hspsThemeServer initiates roll-back functionality removing inconsistent installation.

Client application must call hspsInstallNextPhase() after testing that the synchronous call hspsInstallTheme() has returned EhspsInstallPhaseSuccess return code signalling that actual installation is allowed. The rest of the installation phases will be executed automatically, however, installation can be interrupted by calling hspsCancelInstallTheme() at any time. If installation is canceled, hspsThemeServer initiates roll-back functionality removing inconsistent installation. Installation service uses specific manifest-file format to get informed about the xml, css, dtd, and resource files to be installed. Resource files might be locale-specific or generic as well. hspsThemeServer takes care of saving everything on their appropriate places in the target device's user disk. Theme storage is located in hspsThemeServer's private-folder. Locales are instructed in manifest file also. Manifest file's file-extension must be .dat, but actually, the file-name can be whatever, however, when low-level parametrization is used, the name must be "manifest.dat" and it must be the last file extracted from the installation package. For more information of manifest-file format, see "Xuikon Manifest File User Guide.doc".

Installation functions can return one of the following ThspsServiceCompletedMessage-codes:
  • EhspsInstallThemeSuccess,

  • EhspsInstallPhaseSuccess, or

  • EhspsInstallThemeFailed.

Client application must implement MhspsThemeManagementServiceObserver-interface and listen these messages mentionaed. Let it be emphasised that both synchronous and asynchronous calls can return the codes above. Installation functions may also return one of the following codes:
  • EhspsServiceRequestSheduled, or

  • EhspsServiceRequestError.

For explanation of the meanings of these messages, see ThspsServiceCompletedMessage-documentation.

Since
S60 5.0

Member Functions Documentation

hspsCancelInstallTheme()

ThspsServiceCompletedMessage hspsCancelInstallTheme ( ) [pure virtual]

hspsCancelInstallTheme

Since
S60 5.0

hspsInstallNextPhaseL(ChspsODT &)

ThspsServiceCompletedMessage hspsInstallNextPhaseL ( ChspsODT & aHeader ) [pure virtual]

hspsInstallNextPhase

Since
S60 5.0

Parameters

ChspsODT & aHeader is an empty ChspsODT-object in which a valid ODT-header of the latest installation phase completed if the request was successful. The use of ChspsODT-type parameter follow the high-level parametrization schema.

hspsInstallNextPhaseL(TDes8 &)

ThspsServiceCompletedMessage hspsInstallNextPhaseL ( TDes8 & aHeaderData ) [pure virtual]

hspsInstallNextPhase

Since
S60 5.0

Parameters

TDes8 & aHeaderData will return ODT-header of the latest installation phase in serialized (i.e. marshalled) data mode. This follows the low-level parametrization schema.

hspsInstallTheme(const TDesC &, ChspsODT &)

ThspsServiceCompletedMessage hspsInstallTheme ( const TDesC & aManifestFileName,
ChspsODT & aHeader
) [pure virtual]

hspsInstallTheme

Since
S60 5.0

Parameters

const TDesC & aManifestFileName is the full path to the installation script file - a manifest file.
ChspsODT & aHeader is an empty ChspsODT-object in which a valid ODT-header of the newly installed theme will be returned if the request is successful. The use of ChspsODT-type parameter follows the high-level parametrization schema.

hspsInstallTheme(const TDesC &, TDes8 &)

ThspsServiceCompletedMessage hspsInstallTheme ( const TDesC & aManifestFileName,
TDes8 & aHeaderData
) [pure virtual]

hspsInstallTheme

Since
S60 5.0

Parameters

const TDesC & aManifestFileName is full path of the installation script file - a manifest file
TDes8 & aHeaderData will return ODT-header of the newly installed theme in serialized (i.e. marshalled) data mode. This follows the low-level parametrization schema.