Collapse all Symbian^3 Application Developer Library

CRCSEProfileRegistry Class Reference

class CRCSEProfileRegistry : public CRCSERegistryBase

Offers getting, setting and updating of profiles.

RCSE.lib

Since: S60 3.0

Inherits from

CRCSEProfileRegistry
- CRCSERegistryBase
  - CBase

Public Member Functions
	~CRCSEProfileRegistry ()
IMPORT_C TUint32	AddL (const CRCSEProfileEntry &)
void	AddL ( RPointerArray < CRCSEProfileEntry > &)
IMPORT_C void	DeleteL ( TUint32 )
IMPORT_C void	FindBySIPProfileIdL ( TUint32 , RPointerArray < CRCSEProfileEntry > &)
IMPORT_C void	FindByServiceIdL ( TUint32 , RPointerArray < CRCSEProfileEntry > &)
IMPORT_C void	FindL (const TDesC &, CRCSEProfileEntry &)
IMPORT_C void	FindL ( TUint32 , CRCSEProfileEntry &)
IMPORT_C void	GetAllIdsL ( RArray < TUint32 > &)
IMPORT_C void	GetDefaultProfile ( CRCSEProfileEntry &)
IMPORT_C CRCSEProfileRegistry *	NewL ()
IMPORT_C CRCSEProfileRegistry *	NewLC ()
void	ProfileRegistryErrorOccurred ( TUint32 , TInt )
void	ProfileRegistryEventOccurred ( TUint32 , TEvent)
IMPORT_C void	UpdateL ( TUint32 , const CRCSEProfileEntry &)

Private Member Functions
	CRCSEProfileRegistry ()
void	AddOrUpdateEntryL ( TUint32 &, const CRCSEProfileEntry &)
void	ConstructL ()
void	ConvertEntryToPropertiesL (const CRCSEProfileEntry &, RIpAppPropArray &)
void	ConvertPropertiesToEntryL ( CRCSEProfileEntry &, RIpAppPropArray &)
void	CopyEntryValues (const CRCSEProfileEntry &, CRCSEProfileEntry &)
void	CreateDefaultServiceSettingsL ( CRCSEProfileEntry &)
void	DeleteReferenceSettingsL ( TUint32 )
void	ExtractProtocoIdsL (const TDesC &, RArray < TSettingIds > &)
void	FindEntryL ( TUint32 , CRCSEProfileEntry &)
void	LeaveIfServiceIdInUseL (const CRCSEProfileEntry &)
TBool	NameExistsInServiceTableL (const TDesC &)
void	ResetAndDestroyEntries ( TAny *)
void	UpdateSIPProfileLinksL ( CRCSEProfileEntry &)
void	UpdateServiceIdL ( TUint32 , TUint32 )
void	UpdateServiceSettingsL (const CRCSEProfileEntry &)

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()
	CRCSERegistryBase::BaseConstructL()
	CRCSERegistryBase::BeginL()
	CRCSERegistryBase::CRCSERegistryBase(TRCSERegistryType)
	CRCSERegistryBase::CleanupDbPropArray(TAny *)
	CRCSERegistryBase::CreatePropertyL(TUint,const TDesC &,RIpAppPropArray &)
	CRCSERegistryBase::EndL()
	CRCSERegistryBase::FindAllIdsL(RArray< TUint32 > &)
	CRCSERegistryBase::FindIdsByValueL(TUint,const TDesC &,RArray< TUint32 > &)
	CRCSERegistryBase::GetPropertyValueL(TUint,TDes &,RIpAppPropArray &)
	CRCSERegistryBase::HandleBackupOperationEventL()
	CRCSERegistryBase::ImportSettingsL()
	CRCSERegistryBase::ToDes(TInt32,TDes &)
	CRCSERegistryBase::ToDes(TUint32,TDes &)
	CRCSERegistryBase::ToTInt32L(const TDesC &)
	CRCSERegistryBase::ToTUint32L(const TDesC &)
	CRCSERegistryBase::~CRCSERegistryBase()

Inherited Enumerations
	CRCSERegistryBase:TItemType
	CRCSERegistryBase:TRCSERegistryType

Private Attributes
RPointerArray < CSIPProfile >	iSIPProfiles
CSIPManagedProfileRegistry *	iSIPRegistry

Inherited Attributes
	CRCSERegistryBase::iBackupActive
	CRCSERegistryBase::iBackupObserver
	CRCSERegistryBase::iCenRepDb
	CRCSERegistryBase::iType

Constructor & Destructor Documentation

CRCSEProfileRegistry()

CRCSEProfileRegistry

(

)

[private]

C++ default constructor.

~CRCSEProfileRegistry()

IMPORT_C

~CRCSEProfileRegistry

(

)

[virtual]

Destructor.

Member Functions Documentation

AddL(const CRCSEProfileEntry &)

IMPORT_C TUint32

AddL

(

const CRCSEProfileEntry &

aNewEntry

)

Adds new profile entry.

Since: S60 v3.0

Parameters

const CRCSEProfileEntry & aNewEntry

New entry.

AddL(RPointerArray< CRCSEProfileEntry > &)

void

AddL

(

RPointerArray < CRCSEProfileEntry > &

aEntries

)

Adds bunch of profile entries to store in one transaction. Creates new service provider setting entry to service table if iServiceProviderId has not been set in given profile entry.

Since: S60 v3.2

Parameters

RPointerArray < CRCSEProfileEntry > & aEntries

AddOrUpdateEntryL(TUint32 &, const CRCSEProfileEntry &)

void	AddOrUpdateEntryL	(	TUint32 &	aId,
			const CRCSEProfileEntry &	aEntry
		)	[private]

Adds or updates settings entry to storage depending of the aId parameter. Entry is stored as new entry if aId parameter have been set to KNoEntryId, otherwise existing entry is updated.

Since: S60 v3.2

Parameters

TUint32 & aId	ID of entry if exists.
const CRCSEProfileEntry & aEntry	Entry to be added to storage.

ConstructL()

void

ConstructL

(

)

[private]

By default Symbian 2nd phase constructor is private.

ConvertEntryToPropertiesL(const CRCSEProfileEntry &, RIpAppPropArray &)

void	ConvertEntryToPropertiesL	(	const CRCSEProfileEntry &	aEntry,
			RIpAppPropArray &	properties
		)	[private]

Convert xxx

Since: S60 v3.2.

Parameters

const CRCSEProfileEntry & aEntry
RIpAppPropArray & properties

ConvertPropertiesToEntryL(CRCSEProfileEntry &, RIpAppPropArray &)

void	ConvertPropertiesToEntryL	(	CRCSEProfileEntry &	aEntry,
			RIpAppPropArray &	aProperties
		)	[private]

Convert xxx

Since: S60 v3.2.

Parameters

CRCSEProfileEntry & aEntry
RIpAppPropArray & aProperties

CopyEntryValues(const CRCSEProfileEntry &, CRCSEProfileEntry &)

void	CopyEntryValues	(	const CRCSEProfileEntry &	aSourceEntry,
			CRCSEProfileEntry &	aDestinationEntry
		)	[private]

Copies values from a const entry to a modifiable one.

Since: S60 3.2.

Parameters

const CRCSEProfileEntry & aSourceEntry	Entry whose values are to be copied.
CRCSEProfileEntry & aDestinationEntry	Entry to whom values are copied.

CreateDefaultServiceSettingsL(CRCSEProfileEntry &)

void

CreateDefaultServiceSettingsL

(

CRCSEProfileEntry &

aNewEntry

)

[private]

Creates and stores service provider settings entry with default values, when new profile is created. Service ID of stored service settings is set to profile.

Since: S60 v3.2.

Parameters

CRCSEProfileEntry & aNewEntry

New entry.

DeleteL(TUint32)

IMPORT_C void

DeleteL

(

TUint32

aProfileId

)

Deletes a profile, which profile id is same than aProfileId.

Since: S60 v3.0

Parameters

TUint32 aProfileId

Profile identifier

DeleteReferenceSettingsL(TUint32)

void

DeleteReferenceSettingsL

(

TUint32

aProfileId

)

[private]

Deletes service settings and audio codec settings referenced from profile.

Since: S60 v3.2.

Parameters

TUint32 aProfileId

Id of deleted VoIP profile

ExtractProtocoIdsL(const TDesC &, RArray< TSettingIds > &)

void	ExtractProtocoIdsL	(	const TDesC &	aDes,
			RArray < TSettingIds > &	aArray
		)	[private]

Extract protocol ids from descriptor.

Since: S60 v3.2

Parameters

const TDesC & aDes	Contains TSettingIds structs.
RArray < TSettingIds > & aArray	Contains extracted TSettingIds struct when return.

FindBySIPProfileIdL(TUint32, RPointerArray< CRCSEProfileEntry > &)

IMPORT_C void	FindBySIPProfileIdL	(	TUint32	aSipProfileId,
			RPointerArray < CRCSEProfileEntry > &	aFoundEntries
		)

Search a profiles that have requested aSipProfileId. Content of aFoundEntries array is deleted before the search. On return, aFoundEntries is empty if requested entries are not found.

Since: S60 v3.2.

Parameters

TUint32 aSipProfileId	Search criteria for profiles.
RPointerArray < CRCSEProfileEntry > & aFoundEntries	Container for found profiles

FindByServiceIdL(TUint32, RPointerArray< CRCSEProfileEntry > &)

IMPORT_C void	FindByServiceIdL	(	TUint32	aServiceId,
			RPointerArray < CRCSEProfileEntry > &	aFoundEntries
		)

Search a profiles, where service provider id is same as aServiceId. Content of aFoundEntries array is deleted before the search. On return, aFoundEntries is empty if requested entries are not found.

Since: S60 v3.2.

Parameters

TUint32 aServiceId	Search criteria for profiles.
RPointerArray < CRCSEProfileEntry > & aFoundEntries	Container for found profiles

FindEntryL(TUint32, CRCSEProfileEntry &)

void	FindEntryL	(	TUint32	aProfileId,
			CRCSEProfileEntry &	aFoundEntry
		)	[private]

Do actual search of requested entry. Leaves with KErrNotFound if such profile is not found. Default values are reseted to aFoundEntry before the search.

Since: S60 v3.0.

leave: KErrNotFound if profile doesn't exist.

Parameters

TUint32 aProfileId	Search criteria for profiles.
CRCSEProfileEntry & aFoundEntry	A found profile entry

FindL(const TDesC &, CRCSEProfileEntry &)

IMPORT_C void	FindL	(	const TDesC &	aProviderName,
			CRCSEProfileEntry &	aFoundEntry
		)

Search a profile, which provider name setting is same as aProviderName. Leaves with KErrNotFound if such profile is not found. Default values are reseted to aFoundEntry before the search.

Since: S60 v3.0

Parameters

const TDesC & aProviderName	Search criteria for profiles.
CRCSEProfileEntry & aFoundEntry	A found profile entry, which provider name is same than aProviderName.

FindL(TUint32, CRCSEProfileEntry &)

IMPORT_C void	FindL	(	TUint32	aProfileId,
			CRCSEProfileEntry &	aFoundEntry
		)

Search a profile, which profile id is same as aProfileId. Leaves with KErrNotFound if such profile is not found. Default values are reseted to aFoundEntry before the search.

Since: S60 v3.0.

Parameters

TUint32 aProfileId	Search criteria for profiles.
CRCSEProfileEntry & aFoundEntry	A found profile entry, which provider name is same than aProviderName.

GetAllIdsL(RArray< TUint32 > &)

IMPORT_C void

GetAllIdsL

(

RArray < TUint32 > &

aAllIds

)

Gets all profile identifiers which are stored to RCSE. If there are no profiles stored, aAllIds will contain zero entries.

Since: S60 v3.0

Parameters

RArray < TUint32 > & aAllIds

Array, where the profile identifiers are stored.

GetDefaultProfile(CRCSEProfileEntry &)

IMPORT_C void

GetDefaultProfile

(

CRCSEProfileEntry &

aDefaultProfile

)

const

Resets default values for profile. Default profile is a profile, which can be used when no other profile is available.

Since: S60 v3.0

Parameters

CRCSEProfileEntry & aDefaultProfile

Default profile settings are set to this.

LeaveIfServiceIdInUseL(const CRCSEProfileEntry &)

void

LeaveIfServiceIdInUseL

(

const CRCSEProfileEntry &

aEntry

)

[private]

Checks if service id is used for profile.

Since: S60 3.2.

Parameters

const CRCSEProfileEntry & aEntry

NameExistsInServiceTableL(const TDesC &)

TBool

NameExistsInServiceTableL

(

const TDesC &

aProviderName

)

const [private]

Checks if Service table exist with rerenced entry name.

Since: S60 3.2.

Parameters

const TDesC & aProviderName

NewL()

IMPORT_C CRCSEProfileRegistry *

NewL

(

)

[static]

Two-phased constructor.

NewLC()

IMPORT_C CRCSEProfileRegistry *

NewLC

(

)

[static]

Two-phased constructor.

ProfileRegistryErrorOccurred(TUint32, TInt)

void	ProfileRegistryErrorOccurred	(	TUint32	aSIPProfileId,
			TInt	aError
		)

From MSIPProfileRegistryObserver An asynchronous error has occurred related to SIP profile.

Since: S60 v3.1

Parameters

TUint32 aSIPProfileId	the id of failed profile
TInt aError	a error code

ProfileRegistryEventOccurred(TUint32, TEvent)

void	ProfileRegistryEventOccurred	(	TUint32	aSIPProfileId,
			TEvent	aEvent
		)

From MSIPProfileRegistryObserver SIP profile information event.

Since: S60 v3.1

Parameters

TUint32 aSIPProfileId	id for profile
TEvent aEvent	type of information event

ResetAndDestroyEntries(TAny *)

void

ResetAndDestroyEntries

(

TAny *

anArray

)

[private, static]

Implementation for cleanup item. Resets and destroys array of the entries.

Parameters

TAny * anArray

RPointerArray pointer.

UpdateL(TUint32, const CRCSEProfileEntry &)

IMPORT_C void	UpdateL	(	TUint32	aId,
			const CRCSEProfileEntry &	aUpdateData
		)

Updates profile, which profile identifier is same than aProfileId. Only settings that are set in aUpdateData are updated in profile. Leaves with KErrNotFound if profile is not found.

Since: S60 v3.0

Parameters

TUint32 aId	Profile identifier.
const CRCSEProfileEntry & aUpdateData	Updated data, which are updated to profile.

UpdateSIPProfileLinksL(CRCSEProfileEntry &)

void

UpdateSIPProfileLinksL

(

CRCSEProfileEntry &

aEntry

)

[private]

Validates that linked SIP profiles are up to date. Removes invalid links and updates entry to data base

Since: S60 v3.1

Parameters

CRCSEProfileEntry & aEntry

Profile entry fetched from data base

UpdateServiceIdL(TUint32, TUint32)

void	UpdateServiceIdL	(	TUint32	aId,
			TUint32	aServiceId
		)	[private]

Updates service id related to given entry id.

Since: S60 3.2.

Parameters

TUint32 aId
TUint32 aServiceId	New service id.

UpdateServiceSettingsL(const CRCSEProfileEntry &)

void

UpdateServiceSettingsL

(

const CRCSEProfileEntry &

aEntry

)

[private]

Updates service settings related to aEntry if needed

Since: S60 3.2.

Parameters

const CRCSEProfileEntry & aEntry

Member Data Documentation

RPointerArray< CSIPProfile > iSIPProfiles

RPointerArray < CSIPProfile >

iSIPProfiles

[private]

SIP profiles ( from SIP Profile Client ) Own.

CSIPManagedProfileRegistry * iSIPRegistry

CSIPManagedProfileRegistry *

iSIPRegistry

[private]

SIP registry ( from SIP Profile Client ) Own.