Collapse all Symbian^3 Product Developer Library

CSPSettingsEngine Class Reference

class CSPSettingsEngine : public CBase

Engine class for Service Provider Settings API.

Do actual storage operations for service settings.

serviceprovidersettings.lib

Since: S60 v3.2

Inherits from

CSPSettingsEngine
- CBase

Public Member Functions
	~CSPSettingsEngine()
void	AddEntryL(CSPEntry &)
TInt	AddOrUpdatePropertiesL(TServiceId, const RPropertyArray &)
TInt	BeginTransactionLC()
TInt	CommitTransaction()
TInt	DeleteEntryL(TServiceId)
TInt	DeleteServicePropertiesL(TServiceId, const RPropertyNameArray &)
TInt	FindEntryL(TServiceId, CSPEntry &)
TInt	FindPropertyL(TServiceId, TServicePropertyName, CSPProperty &)
void	FindServiceIdsFromPropertiesL(const RPropertyArray &, RIdArray &)
TInt	FindServiceIdsL(RIdArray &)
void	FindServiceNamesL(RIdArray &, CDesCArray &)
TInt	FindSubServicePropertiesL(TServiceId, TSPItemType, RPropertyArray &)
TBool	HasCallPropertyName(const RPropertyNameArray &)
TBool	HasVoIPAndVmbxPropertyName(const RPropertyNameArray &)
TBool	IsFeatureSupportedL(TSPServiceFeature, TBool)
TBool	IsVoIPServiceL(TServiceId)
void	NameArrayFromPropertyArrayL(RPropertyNameArray &, const RPropertyArray &)
CSPSettingsEngine *	NewL()
CSPSettingsEngine *	NewLC()
void	RollbackTransaction()
TInt	SettingsCountL()
TInt	UpdateEntryL(const CSPEntry &)
void	UpdateSupportFeaturePSKeyL()

Private Member Functions
	CSPSettingsEngine()
TBool	CheckFeatureL(TInt, TInt)
void	CleanupPointerArray(TAny *)
void	ConstructL()
void	ConvertSpArrayToCenRepArrayL(const RPropertyArray &, RIpAppPropArray &)
void	ConvertSpEntryToCenRepArrayL(const CSPEntry &, RIpAppPropArray &)
void	PropertyNameArrayFromItemTypeL(TSPItemType, RPropertyNameArray &)

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
CCenRepDatabaseUtil *	iCenRepUtils

Constructor & Destructor Documentation

CSPSettingsEngine()

CSPSettingsEngine

(

)

[private]

C++ default constructor.

~CSPSettingsEngine()

~CSPSettingsEngine

(

)

[virtual]

Destructors.

Member Functions Documentation

AddEntryL(CSPEntry &)

void

AddEntryL

(

CSPEntry &

aEntry

)

Stores new service provider settings entry

Since: S60 v3.2

Parameters

CSPEntry & aEntry

New service provider settings entry, on return service Id is filled in

AddOrUpdatePropertiesL(TServiceId, const RPropertyArray &)

TInt	AddOrUpdatePropertiesL	(	TServiceId	aServiceId,
			const RPropertyArray &	aPropertyArray
		)

Add or update properties of service provider settings entry to storage. If property name exists, update property. If property doesn't exist,

Since: S60 v3.2

Parameters

TServiceId aServiceId	The ID of updated service entry
const RPropertyArray & aPropertyArray	new properties to be added or updated

BeginTransactionLC()

TInt

BeginTransactionLC

(

)

Starts transaction in repository

Since: S60 v3.2

CheckFeatureL(TInt, TInt)

TBool	CheckFeatureL	(	TInt	aMask,
			TInt	aValue
		)	[private]

Walk through all the sevices and check there is any service match

Since: S60 v3.2

Parameters

TInt aMask	attribute mask
TInt aValue	value to be checked

CleanupPointerArray(TAny *)

void

CleanupPointerArray

(

TAny *

aPointer

)

[private, static]

Parameters

TAny * aPointer

CommitTransaction()

TInt

CommitTransaction

(

)

Commits changes in repository

Since: S60 v3.2

ConstructL()

void

ConstructL

(

)

[private]

By default Symbian 2nd phase constructor is private.

ConvertSpArrayToCenRepArrayL(const RPropertyArray &, RIpAppPropArray &)

void	ConvertSpArrayToCenRepArrayL	(	const RPropertyArray &	aSpArray,
			RIpAppPropArray &	aCenRepArray
		)	[private]

Parameters

const RPropertyArray & aSpArray
RIpAppPropArray & aCenRepArray

ConvertSpEntryToCenRepArrayL(const CSPEntry &, RIpAppPropArray &)

void	ConvertSpEntryToCenRepArrayL	(	const CSPEntry &	aEntry,
			RIpAppPropArray &	aArray
		)	[private]

Parameters

const CSPEntry & aEntry
RIpAppPropArray & aArray

DeleteEntryL(TServiceId)

TInt

DeleteEntryL

(

TServiceId

aServiceId

)

Deletes service provider settings entry from storage by service ID.

Since: S60 v3.2

Parameters

TServiceId aServiceId

DeleteServicePropertiesL(TServiceId, const RPropertyNameArray &)

TInt	DeleteServicePropertiesL	(	TServiceId	aServiceId,
			const RPropertyNameArray &	aNameArray
		)

Deletes service properties by service ID and property name.

Since: S60 v3.2

Parameters

TServiceId aServiceId	The service ID of requested service entry
const RPropertyNameArray & aNameArray	name of properties to be deleted

FindEntryL(TServiceId, CSPEntry &)

TInt	FindEntryL	(	TServiceId	aServiceId,
			CSPEntry &	aEntry
		)

Search service provider settings entry by service ID.

Since: S60 v3.2

Parameters

TServiceId aServiceId	Id of requested xSP settings entry
CSPEntry & aEntry	on return, SP settings entry corresponding to aServiceId.

FindPropertyL(TServiceId, TServicePropertyName, CSPProperty &)

TInt	FindPropertyL	(	TServiceId	aServiceId,
			TServicePropertyName	aPropertyName,
			CSPProperty &	aProperty
		)

Search property of service provider settings entry from storage.

Since: S60 v3.2

Parameters

TServiceId aServiceId	The service ID of requested service entry
TServicePropertyName aPropertyName	property name to be found
CSPProperty & aProperty	on return, requested property

FindServiceIdsFromPropertiesL(const RPropertyArray &, RIdArray &)

void	FindServiceIdsFromPropertiesL	(	const RPropertyArray &	aPropertyArray,
			RIdArray &	aServiceIds
		)

Find service IDs with same properties

Since: S60 v3.2

Parameters

const RPropertyArray & aPropertyArray	property array
RIdArray & aServiceIds

FindServiceIdsL(RIdArray &)

TInt

FindServiceIdsL

(

RIdArray &

aServiceIds

)

Search all service provider IDs from storage

Since: S60 v3.2

Parameters

RIdArray & aServiceIds

An array containing returned service IDs

FindServiceNamesL(RIdArray &, CDesCArray &)

void	FindServiceNamesL	(	RIdArray &	aServiceIds,
			CDesCArray &	aServiceNames
		)

Search all service names from settings storage by given service IDs. Removes service ID from given array if corresponding service name is not found.

Since: S60 v3.2

Parameters

RIdArray & aServiceIds	An array of service IDs
CDesCArray & aServiceNames	on return, array which saves found service names

FindSubServicePropertiesL(TServiceId, TSPItemType, RPropertyArray &)

TInt	FindSubServicePropertiesL	(	TServiceId	aServiceId,
			TSPItemType	aPropertyType,
			RPropertyArray &	aPropertyArray
		)

Search subservice properties of requested service provider settings entry by ID.

Since: S60 v3.2

Parameters

TServiceId aServiceId	The ID of requested service entry
TSPItemType aPropertyType	property type of sub service
RPropertyArray & aPropertyArray	on return, array which saves found subservice properties

HasCallPropertyName(const RPropertyNameArray &)

TBool

HasCallPropertyName

(

const RPropertyNameArray &

aNameArray

)

Check if an array has call related property name in it

Since: S60 v3.2.3

Parameters

const RPropertyNameArray & aNameArray

HasVoIPAndVmbxPropertyName(const RPropertyNameArray &)

TBool

HasVoIPAndVmbxPropertyName

(

const RPropertyNameArray &

aNameArray

)

Check if an array has VoIP or Vmbx related property name in it

Since: S60 v3.2.3

Parameters

const RPropertyNameArray & aNameArray

IsFeatureSupportedL(TSPServiceFeature, TBool)

TBool	IsFeatureSupportedL	(	TSPServiceFeature	aFeature,
			TBool	aWriteAllowed
		)

Check feature is supported or not

Since: S60 v3.2

Parameters

TSPServiceFeature aFeature
TBool aWriteAllowed

IsVoIPServiceL(TServiceId)

TBool

IsVoIPServiceL

(

TServiceId

aServiceId

)

Check if it is VoIP Service ID

Since: S60 v3.2.3

Parameters

TServiceId aServiceId

NameArrayFromPropertyArrayL(RPropertyNameArray &, const RPropertyArray &)

void	NameArrayFromPropertyArrayL	(	RPropertyNameArray &	aNameArray,
			const RPropertyArray &	aPropertyArray
		)

Get Name array from Property array

Since: S60 v3.2.3

Parameters

RPropertyNameArray & aNameArray
const RPropertyArray & aPropertyArray

NewL()

CSPSettingsEngine *

NewL

(

)

[static]

Two-phased constructor.

NewLC()

CSPSettingsEngine *

NewLC

(

)

[static]

Two-phased constructor.

PropertyNameArrayFromItemTypeL(TSPItemType, RPropertyNameArray &)

void	PropertyNameArrayFromItemTypeL	(	TSPItemType	aPropertyType,
			RPropertyNameArray &	aNameArray
		)	[private]

Parameters

TSPItemType aPropertyType
RPropertyNameArray & aNameArray

RollbackTransaction()

void

RollbackTransaction

(

)

Rollback changes in repository

Since: S60 v3.2

SettingsCountL()

TInt

SettingsCountL

(

)

Return count of service provider settings entries in storage.

Since: S60 v3.2

UpdateEntryL(const CSPEntry &)

TInt

UpdateEntryL

(

const CSPEntry &

aEntry

)

Updates service provider settings entry to settings storage.

Since: S60 v3.2

Parameters

const CSPEntry & aEntry

Updated service provider settings entry

UpdateSupportFeaturePSKeyL()

void

UpdateSupportFeaturePSKeyL

(

)

When service table is changed, update the P&S key

Since: S60 v3.2

Member Data Documentation

CCenRepDatabaseUtil * iCenRepUtils

CCenRepDatabaseUtil *

iCenRepUtils

[private]