Symbian^3 Application Developer Library >

CIAUpdateParameters Class Reference

class CIAUpdateParameters : public CBase

CIAUpdateParameters defines the update targets. The update action will be directed only to the objects that qualify at least one of the parameter requirements.

CIAUpdate The operation functions provide more detailed description about what combinations of the parameter values are supported.
Since
S60 v3.2

Inherits from

Public Member Functions
~CIAUpdateParameters ()
IMPORT_C const TDesC8 & CommandLineArguments ()
IMPORT_C const TDesC & CommandLineExecutable ()
IMPORT_C TUint Importance ()
IMPORT_C CIAUpdateParameters * NewL ()
IMPORT_C CIAUpdateParameters * NewLC ()
IMPORT_C TBool Refresh ()
IMPORT_C const TDesC & SearchCriteria ()
IMPORT_C void SetCommandLineArgumentsL (const TDesC8 &)
IMPORT_C void SetCommandLineExecutableL (const TDesC &)
IMPORT_C void SetImportance ( TUint )
IMPORT_C void SetRefresh ( TBool )
IMPORT_C void SetSearchCriteriaL (const TDesC &)
IMPORT_C void SetShowProgress ( TBool )
IMPORT_C void SetType ( TUint )
IMPORT_C void SetUid (const TUid &)
IMPORT_C TBool ShowProgress ()
IMPORT_C TUint Type ()
IMPORT_C const TUid & Uid ()
Private Member Functions
CIAUpdateParameters ()
CIAUpdateParameters (const CIAUpdateParameters &)
void ConstructL ()
CIAUpdateParameters & operator= (const CIAUpdateParameters &)
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()
Public Member Enumerations
enum TUpdateImportance {
ETest  = 0x1, ENormal  = 0x2, ERecommended  = 0x4, ECritical  = 0x8, EMandatory  = 0x10, EHidden  = 0x20
}
enum TUpdateType { ESis  = 0x1, EFota  = 0x2, ENsu  = 0x4 }
Private Attributes
HBufC8 * iCommandLineArguments
HBufC * iCommandLineExecutable
TUint iImportance
TBool iRefresh
HBufC * iSearchCriteria
TBool iShowProgress
TUint iType
TUid iUid

Constructor & Destructor Documentation

CIAUpdateParameters()

CIAUpdateParameters ( ) [private]

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

CIAUpdateParameters::NewL
Since
S60 v3.2

CIAUpdateParameters(const CIAUpdateParameters &)

CIAUpdateParameters ( const CIAUpdateParameters & aObject ) [private]

Parameters

const CIAUpdateParameters & aObject

~CIAUpdateParameters()

IMPORT_C ~CIAUpdateParameters ( ) [virtual]

Destructor

Since
S60 v3.2

Member Functions Documentation

CommandLineArguments()

IMPORT_C const TDesC8 & CommandLineArguments ( ) const
Since
S60 v3.2

CommandLineExecutable()

IMPORT_C const TDesC & CommandLineExecutable ( ) const
Since
S60 v3.2

ConstructL()

void ConstructL ( ) [private]
CIAUpdateParameters::NewL
Since
S60 v3.2

Importance()

IMPORT_C TUint Importance ( ) const

NewL()

IMPORT_C CIAUpdateParameters * NewL ( ) [static]
Exceptions
Leaves

with system wide error code.

Since
S60 v3.2

NewLC()

IMPORT_C CIAUpdateParameters * NewLC ( ) [static]

CIAUpdateParameters::NewL

Refresh()

IMPORT_C TBool Refresh ( ) const

SearchCriteria()

IMPORT_C const TDesC & SearchCriteria ( ) const
Since
S60 v3.2

SetCommandLineArgumentsL(const TDesC8 &)

IMPORT_C void SetCommandLineArgumentsL ( const TDesC8 & aCommandLineArguments )
Since
S60 v3.2

Parameters

const TDesC8 & aCommandLineArguments When the update operation finishes, the content of this desciptor will be used as command line arguments with the command line executable.

SetCommandLineExecutableL(const TDesC &)

IMPORT_C void SetCommandLineExecutableL ( const TDesC & aCommandLineExecutable )
Since
S60 v3.2

Parameters

const TDesC & aCommandLineExecutable

SetImportance(TUint)

IMPORT_C void SetImportance ( TUint aImportance )

Parameters

TUint aImportance

SetRefresh(TBool)

IMPORT_C void SetRefresh ( TBool aRefresh )

Parameters

TBool aRefresh

SetSearchCriteriaL(const TDesC &)

IMPORT_C void SetSearchCriteriaL ( const TDesC & aSearchCriteria )
Since
S60 v3.2

Parameters

const TDesC & aSearchCriteria When correct updates are searched, this text is used as a criteria when checking the information that is attached to the updates.

SetShowProgress(TBool)

IMPORT_C void SetShowProgress ( TBool aShowProgress )

If this parameter is set to ETrue, a ready-made wait dialog with localized texts is shown if CIAUpdate::CheckUpdates operation takes longer time to complete. This happens e.g. if the updates are refreshed from the server.

CIAUpdate::CheckUpdates
Since
S60 v3.2

Parameters

TBool aShowProgress If ETrue, a wait dialog is shown when CIAUpdate::CheckUpdates operation is started. If EFalse, the dialog is not shown.

SetType(TUint)

IMPORT_C void SetType ( TUint aType )

Parameters

TUint aType

SetUid(const TUid &)

IMPORT_C void SetUid ( const TUid & aUid )
Since
S60 v3.2

Parameters

const TUid & aUid Uid describes either package UID or SID.

ShowProgress()

IMPORT_C TBool ShowProgress ( ) const

If this parameter is set to ETrue, a ready-made wait dialog with localized texts is shown if CIAUpdate::CheckUpdates operation takes longer time to complete. This happens e.g. if the updates are refreshed from the server.

CIAUpdate::CheckUpdates
Since
S60 v3.2

Type()

IMPORT_C TUint Type ( ) const

Uid()

IMPORT_C const TUid & Uid ( ) const
Since
S60 v3.2

operator=(const CIAUpdateParameters &)

CIAUpdateParameters & operator= ( const CIAUpdateParameters & aObject ) [private]

Parameters

const CIAUpdateParameters & aObject

Member Enumerations Documentation

Enum TUpdateImportance

Enumerators

ETest = 0x1
ENormal = 0x2
ERecommended = 0x4
ECritical = 0x8
EMandatory = 0x10
EHidden = 0x20

Enum TUpdateType

Enumerators

ESis = 0x1
EFota = 0x2
ENsu = 0x4

Member Data Documentation

HBufC8 * iCommandLineArguments

HBufC8 * iCommandLineArguments [private]

HBufC * iCommandLineExecutable

HBufC * iCommandLineExecutable [private]

TUint iImportance

TUint iImportance [private]

TBool iRefresh

TBool iRefresh [private]

HBufC * iSearchCriteria

HBufC * iSearchCriteria [private]

TBool iShowProgress

TBool iShowProgress [private]

TUint iType

TUint iType [private]

TUid iUid

TUid iUid [private]

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.