Collapse all Symbian^3 Application Developer Library

CIAUpdate Class Reference

class CIAUpdate : public CBase

CIAUpdate object provides methods to handle update actions. Updating will be targeted to the update items that qualify the requirements given in CIAUpdateParameters objects. In asynchronous actions, the callback functions of MIAUpdateObserver object will be informed about the progress of update actions.

MIAUpdateObserver CIAUpdateParameters

Since: S60 v3.2

Inherits from

CIAUpdate
- CBase

Public Member Functions
	~CIAUpdate ()
IMPORT_C void	CheckUpdates (const CIAUpdateParameters &)
IMPORT_C CIAUpdate *	NewL ( MIAUpdateObserver &)
IMPORT_C CIAUpdate *	NewLC ( MIAUpdateObserver &)
IMPORT_C void	ShowUpdates (const CIAUpdateParameters &)
IMPORT_C void	Update (const CIAUpdateParameters &)
IMPORT_C void	UpdateQuery ()

Private Member Functions
	CIAUpdate ()
	CIAUpdate (const CIAUpdate &)
void	ConstructL ( MIAUpdateObserver &)
CIAUpdateManager &	UpdateManager ()
CIAUpdate &	operator= (const CIAUpdate &)

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Private Attributes
CIAUpdateManager *	iUpdateManager

Constructor & Destructor Documentation

CIAUpdate()

CIAUpdate

(

)

[private]

Constructor is private because this class is not meant for inheritance.

NewL

CIAUpdate(const CIAUpdate &)

CIAUpdate

(

const CIAUpdate &

aObject

)

[private]

Parameters

const CIAUpdate & aObject

~CIAUpdate()

IMPORT_C

~CIAUpdate

(

)

[virtual]

Destructor

Since: S60 v3.2

Member Functions Documentation

CheckUpdates(const CIAUpdateParameters &)

IMPORT_C void

CheckUpdates

(

const CIAUpdateParameters &

aUpdateParameters

)

Checks if any updates are available. This function is asynchronic.

Note:

Update check is directed to items that match:

Uid describes either package UID or SID. UID is assumed to be SID if update items are not found with the given UID. Then, corresponding package UID is searched from the installed application registry. If corresponding package UID is found, then update items are rechecked.

If Uid is given, then search criteria is omitted.

If none of the parameters that are mentioned above is not set, then all the updates are checked.

CIAUpdateParameters::ShowProgress defines if a ready-made wait dialog should be shown in case the operation takes longer time. This happens e.g. if the updates are refreshed from the server.

Since: S60 v3.2

Parameters

const CIAUpdateParameters & aUpdateParameters

Defines the update targets.

ConstructL(MIAUpdateObserver &)

void

ConstructL

(

MIAUpdateObserver &

aObserver

)

[private]

NewL

Parameters

MIAUpdateObserver & aObserver

NewL(MIAUpdateObserver &)

IMPORT_C CIAUpdate *

NewL

(

MIAUpdateObserver &

aObserver

)

[static]

Since: S60 v3.2

Parameters

MIAUpdateObserver & aObserver

Callback functions of the observer are called when operations that are started from this interface progress.

NewLC(MIAUpdateObserver &)

IMPORT_C CIAUpdate *

NewLC

(

MIAUpdateObserver &

aObserver

)

[static]

NewL

Parameters

MIAUpdateObserver & aObserver

ShowUpdates(const CIAUpdateParameters &)

IMPORT_C void

ShowUpdates

(

const CIAUpdateParameters &

aUpdateParameters

)

Starts IAD UI.

UI will show the update items that qualify the requirements given in aUpdateParameters.

Even if the updating is handled in the IAD UI, the observer is informed about the progression of operations. So, the calling application may continue correctly after updates are finished.

Note:

IAD UI will show update items that match:

If Uid is given, then search criteria is omitted.

If none of the parameters that are mentioned above is not set, then all the updates are shown in the UI.

When update finishes, the following values are used for command line execution:

If CIAUpdateParameters::CommandLineExecutable is not set, then no command line execution is done.

Since: S60 v3.2

Parameters

const CIAUpdateParameters & aUpdateParameters

Defines the update targets.

Update(const CIAUpdateParameters &)

IMPORT_C void

Update

(

const CIAUpdateParameters &

aUpdateParameters

)

All the items that qualify the requirements given in aUpdateParameters will be updated without opening the IAD UI. This function is asynchronic.

Note:

Update is directed to items that match:

If Uid is given, then search criteria is omitted.

If none of the parameters that are mentioned above is not set, then everything is updated.

When update finishes, the following values are used for command line execution:

If CIAUpdateParameters::CommandLineExecutable is not set, then no command line execution is done.

Since: S60 v3.2

Parameters

const CIAUpdateParameters & aUpdateParameters

Defines the update targets.

UpdateManager()

CIAUpdateManager &

UpdateManager

(

)

const [private]

UpdateQuery()

IMPORT_C void

UpdateQuery

(

)

This function is provided as a convenience method that has localized texts for the query dialog. This function does not start any update. This function is asynchronic.

Note:

The observer is informed when the update query operation has completed.

Since: S60 v3.2

operator=(const CIAUpdate &)

CIAUpdate &

operator=

(

const CIAUpdate &

aObject

)

[private]

Parameters

const CIAUpdate & aObject

Member Data Documentation

CIAUpdateManager * iUpdateManager

CIAUpdateManager *

iUpdateManager

[private]