Collapse all Symbian^3 Product Developer Library

MNcdNodeInstall Class Reference

class MNcdNodeInstall : public MCatalogsBase

Provides functions that can be used to install the node object. Before installing, the data should have been downloaded using download interface.

MNcdNodeDownload MNcdNodeUriContent

Inherits from

MNcdNodeInstall
- MCatalogsBase

Public Member Functions
MNcdInstallOperation *	InstallL(MNcdInstallOperationObserver &)
RCatalogsArray< MNcdInstalledContent >	InstalledContentL()
TBool	IsInstalledL()
TBool	IsLaunchable()
void	SetApplicationInstalledL(TInt)
MNcdInstallOperation *	SilentInstallL(MNcdInstallOperationObserver &, const SwiUI::TInstallOptions &)

Protected Member Functions
	~MNcdNodeInstall()

Inherited Functions
	MCatalogsBase::AddRef()const
	MCatalogsBase::QueryInterfaceL()
	MCatalogsBase::QueryInterfaceL()const
	MCatalogsBase::QueryInterfaceL(TInt)const
	MCatalogsBase::QueryInterfaceLC()
	MCatalogsBase::QueryInterfaceLC()const
	MCatalogsBase::Release()const
	MCatalogsBase::~MCatalogsBase()

Inherited Enumerations
	MCatalogsBase:@46

Constructor & Destructor Documentation

~MNcdNodeInstall()

~MNcdNodeInstall

(

)

[protected, inline, virtual]

Destructor.

MCatalogsBase::~MCatalogsBase()

Member Functions Documentation

InstallL(MNcdInstallOperationObserver &)

MNcdInstallOperation *

InstallL

(

MNcdInstallOperationObserver &

aObserver

)

[pure virtual]

Starts the installing operation of the node object.

Note:

The reference count of the operation object is increased by one. So, Release() function of the operation should be called when operation is not needed anymore.

Exceptions

Leave

System wide error code. Leaves with KNcdErrorParallelOperationNotAllowed if a parallel client is running an operation for the same metadata. See MNcdOperation for full explanation.

Parameters

MNcdInstallOperationObserver & aObserver

Observer for the operation.

InstalledContentL()

RCatalogsArray< MNcdInstalledContent >

InstalledContentL

(

)

[pure virtual]

Returns an array of content installed from the item

Exceptions

Leave

System wide error code.

IsInstalledL()

TBool

IsInstalledL

(

)

const [pure virtual]

Checks if the item content has already been installed and is currently present in the device.

Note:

This returns EFalse if some of the content is missing, eg. if one of several image files has been deleted.

Exceptions

Leave

System wide error code.

IsLaunchable()

TBool

IsLaunchable

(

)

const [pure virtual]

Checks if the item is allowed to be launched.

Note:

This returns ETrue if at least one of installed themes/applications/files is launchable

Note:

This method does not check if the item has been installed or if it's currently present.

SetApplicationInstalledL(TInt)

void

SetApplicationInstalledL

(

TInt

aErrorCode

)

[pure virtual]

This function may be used to update install information of the node if the node content has been externally installed.

Note:

The use of this function should be avoided in normal install cases. In normal install cases, all the necessary actions are done automatically. This function should only be used if node content is installed externally and the content can not be installed by using other functions provided in this interface. This function is meant only for the application content. The content has to be downloaded by using MNcdNodeDownload interface before using this function.

When this function is called with KErrNone parameter, the node content is assumed to be succesfully installed. Therefore, possible content installation files will be deleted as in normal succesfull install cases. The purchase history details and installation report information are updated to correspond the given error code information.

Exceptions

Leave

System wide error code.

Parameters

TInt aErrorCode

The error code describes the success of the install. If KErrNone is given, then the installation is assumed to be a success. If some other error code is given, then the installation is assumed to fail in some way. The details related to the installations are updated according to the error code.

SilentInstallL(MNcdInstallOperationObserver &, const SwiUI::TInstallOptions &)

MNcdInstallOperation *	SilentInstallL	(	MNcdInstallOperationObserver &	aObserver,
			const SwiUI::TInstallOptions &	aInstallOptions
		)	[pure virtual]

Starts the silent installing operation of the node object. Because installation is silent, normal installation query dialogs are not shown. But, the caller of this function may use aInstallOptions parameter to define that text files that are included in SIS packages will be shown in query dialogs during installation. This may be required, for example, to show disclaimers that are included in the SIS packages as text files.

Note:

The reference count of the operation object is increased by one. So, Release() function of the operation should be called when operation is not needed anymore.

Requires TrustedUI capabilities

Only SIS packages and Java archives are installed silently, other content is installed exactly like with InstallL

Exceptions

Leave

System wide error code. Leaves with KErrPermissionDenied if UI does not have TrustedUI capability. Leaves with KNcdErrorParallelOperationNotAllowed if a parallel client is running an operation for the same metadata. See MNcdOperation for full explanation.

Parameters

MNcdInstallOperationObserver & aObserver	Observer for the operation.
const SwiUI::TInstallOptions & aInstallOptions	These install options are used by the silent install.