Collapse all Symbian^3 Product Developer Library

CPbkContactEngine Class Reference

class CPbkContactEngine : public CBase

The main entrypoint to the Phonebook contact engine. The Phonebook contact engine builds on top of the Symbian Contacts model and implements platform specific functionality and policies that can be reused and followed by clients to implement functionality that is better integrated to the platform functionality. Functionality like contact field typing is implemented by this engine.

Inherits from

CPbkContactEngine
- CBase

Nested Classes and Structures

CPbkContactEngine::CContactDbConnection

Public Member Functions
	~CPbkContactEngine()
IMPORT_C void	AddContactToGroupL(TContactItemId, TContactItemId)
IMPORT_C TContactItemId	AddNewContactL(CPbkContactItem &, TBool)
IMPORT_C CContactViewBase &	AllContactsView()
IMPORT_C CContactViewBase &	AllGroupsViewL()
IMPORT_C void	CancelCompress()
IMPORT_C TBool	CheckCompress()
IMPORT_C void	CheckFileSystemSpaceAndCompressL()
IMPORT_C void	CloseContactL(TContactItemId)
IMPORT_C void	CommitContactGroupL(CContactGroup &, TBool)
IMPORT_C void	CommitContactL(CPbkContactItem &, TBool)
IMPORT_C void	CompressL()
IMPORT_C CPbkConstants *	Constants()
IMPORT_C MPbkContactNameFormat &	ContactNameFormat()
IMPORT_C CPbkContactChangeNotifier *	CreateContactChangeNotifierL(MPbkContactDbObserver *)
IMPORT_C CContactGroup *	CreateContactGroupL(const TDesC &, TBool)
IMPORT_C CPbkContactIter *	CreateContactIteratorLC(TBool)
IMPORT_C CPbkContactItem *	CreateEmptyContactL()
IMPORT_C CContactDatabase &	Database()
IMPORT_C void	DeleteContactGroupL(TContactItemId, TBool)
IMPORT_C void	DeleteContactL(TContactItemId, TBool)
IMPORT_C void	DeleteContactsL(const CContactIdArray &, TBool)
IMPORT_C void	DeleteContactsOnBackgroundL(const CContactIdArray &)
IMPORT_C TContactItemId	DuplicateContactL(TContactItemId, TBool)
IMPORT_C const CPbkFieldsInfo &	FieldsInfo()
IMPORT_C CContactViewBase &	FilteredContactsViewL(TInt)
IMPORT_C CPbkIdleFinder *	FindAsyncL(const TDesC &, const CPbkFieldIdArray , MIdleFindObserver )
IMPORT_C CContactIdArray *	FindLC(const TDesC &, const CPbkFieldIdArray *)
IMPORT_C RFs &	FsSession()
IMPORT_C HBufC *	GetContactTitleL(const CPbkContactItem &)
IMPORT_C HBufC *	GetContactTitleOrNullL(const MPbkFieldDataArray &)
IMPORT_C TContactItemId	GetSpeedDialFieldL(TInt, TDes &)
IMPORT_C TBool	IsSpeedDialAssigned(const CPbkContactItem &, TInt)
IMPORT_C TBool	IsTitleField(TPbkFieldId)
IMPORT_C CContactIdArray *	MatchPhoneNumberL(const TDesC &, const TInt)
IMPORT_C TPbkNameOrder	NameDisplayOrderL()
IMPORT_C TChar	NameSeparator()
IMPORT_C CPbkContactEngine *	NewL(RFs *)
IMPORT_C CPbkContactEngine *	NewL(const TDesC &, TBool, RFs *)
IMPORT_C CContactGroup *	OpenContactGroupL(TContactItemId)
IMPORT_C CContactGroup *	OpenContactGroupLCX(TContactItemId)
IMPORT_C CPbkContactItem *	OpenContactL(TContactItemId)
IMPORT_C CPbkContactItem *	OpenContactLCX(TContactItemId)
IMPORT_C CContactGroup *	ReadContactGroupL(TContactItemId)
IMPORT_C CPbkContactItem *	ReadContactL(TContactItemId, const CPbkFieldIdArray *)
IMPORT_C CPbkContactItem *	ReadContactLC(TContactItemId, const CPbkFieldIdArray *)
IMPORT_C CPbkContactItem *	ReadMinimalContactLC(TContactItemId)
IMPORT_C void	RemoveContactFromGroupL(TContactItemId, TContactItemId)
IMPORT_C void	RemoveSpeedDialFieldL(TContactItemId, TInt)
IMPORT_C CPbkContactEngine *	ReplaceL(RFs *)
IMPORT_C void	SetCompressUi(MPbkCompressUi *)
IMPORT_C void	SetFieldAsSpeedDialL(CPbkContactItem &, TInt, TInt)
IMPORT_C void	SetNameDisplayOrderL(TPbkNameOrder)
IMPORT_C void	SetNameSeparatorL(TChar)
const CPbkSortOrderManager &	SortOrderManager()
IMPORT_C CPbkContactEngine *	Static()
IMPORT_C const TDesC &	UnnamedTitle()

Private Member Functions
	CPbkContactEngine()
void	AddObserverL(MPbkContactDbObserver *)
void	ConnectFsL(RFs *)
void	ConstructL(const TDesC , TBool, RFs )
void	CreateDbConnectionL(const TDesC *, TBool, TInt &, TBool)
void	HandleDatabaseEventL(TContactDbObserverEvent)
void	ReadResourcesL(TBool &)
void	RemoveObserver(MPbkContactDbObserver *)
void	SendEventToAllObservers(const TContactDbObserverEvent &)
void	SendImmidiateEventToAllObservers(TContactDbObserverEventType, TContactItemId, TBool)
void	doDeleteContactL(TContactItemId)

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	TPbkNameOrder { EPbkNameOrderLastNameFirstName = 0, EPbkNameOrderFirstNameLastName, EPbkNameOrderNotDefined }

Private Attributes
CContactDbConnection *	iDbConnection
TUid	iDtorIDKey
CPbkEngineExtension *	iExtension
TInt	iFreeSpaceRequiredToDelete
RFs	iFs
CArrayPtr< MPbkContactDbObserver > *	iObservers
RFs	iOwnFs
CPbkConstants *	iPbkConstants
CPbkFieldsInfo *	iPbkFieldsInfo
CPbkSINDHandlerInterface *	iSINDHandler
TChar	iSeparator
RSharedDataClient *	iSharedDataClient
TBool	iUseSeparator

Constructor & Destructor Documentation

CPbkContactEngine()

CPbkContactEngine

(

)

[private, inline]

~CPbkContactEngine()

~CPbkContactEngine

(

)

Destructor. Destroys this object and closes the contact database connection. REComSession::FinalClose() is called. Notice that FinalClose -call releases resource handles of already destroyed ECom plugins also outside CPbkContactEngine. See REComSession documentation.

Member Functions Documentation

AddContactToGroupL(TContactItemId, TContactItemId)

IMPORT_C void	AddContactToGroupL	(	TContactItemId	aItemId,
			TContactItemId	aGroupId
		)

Adds a Contact to a group.

CContactDatabase::AddContactToGroupL

Parameters

TContactItemId aItemId	Contact to be added to group.
TContactItemId aGroupId	Group where the contact will be added to.

AddNewContactL(CPbkContactItem &, TBool)

IMPORT_C TContactItemId	AddNewContactL	(	CPbkContactItem &	aContact,
			TBool	aImmediateNotify = EFalse
		)

Adds a new contact to the contact database.

CContactDatabase::AddNewContactL

Parameters

CPbkContactItem & aContact	The new contact item to add.
TBool aImmediateNotify = EFalse	Send notification to observers immediately. NOTE: send immediately will result in observers (MPbkContactDbObserver) receiving the event twice!

AddObserverL(MPbkContactDbObserver *)

void

AddObserverL

(

MPbkContactDbObserver *

aObserver

)

[private]

Parameters

MPbkContactDbObserver * aObserver

AllContactsView()

IMPORT_C CContactViewBase &

AllContactsView

(

)

Returns a contact view object containing all the contacts in the database.

CContactViewBase

AllGroupsViewL()

IMPORT_C CContactViewBase &

AllGroupsViewL

(

)

Returns a contact view object containing all the groups in the database.

CContactViewBase

CancelCompress()

IMPORT_C void

CancelCompress

(

)

CheckCompress()

IMPORT_C TBool

CheckCompress

(

)

CheckFileSystemSpaceAndCompressL()

IMPORT_C void

CheckFileSystemSpaceAndCompressL

(

)

CloseContactL(TContactItemId)

IMPORT_C void

CloseContactL

(

TContactItemId

aContactId

)

Closes a previously opened contact item without saving changes. CContactDatabase::CloseContactL

Parameters

TContactItemId aContactId

Contact item to be closed.

CommitContactGroupL(CContactGroup &, TBool)

IMPORT_C void	CommitContactGroupL	(	CContactGroup &	aGroup,
			TBool	aImmediateNotify = EFalse
		)

Commits changes to a contact group to the database.

CContactDatabase::CommitContactL

Parameters

CContactGroup & aGroup
TBool aImmediateNotify = EFalse	Send notification to observers immediately. NOTE: send immediately will result in observers (MPbkContactDbObserver) receiving the event twice!

CommitContactL(CPbkContactItem &, TBool)

IMPORT_C void	CommitContactL	(	CPbkContactItem &	aContact,
			TBool	aImmediateNotify = EFalse
		)

Commit changes to a previously opened contact item into the contact database.

CContactDatabase::CommitContactL

Parameters

CPbkContactItem & aContact	Contact item to be updated in the database.
TBool aImmediateNotify = EFalse	Send notification to observers immediately. NOTE: send immediately will result in observers (MPbkContactDbObserver) receiving the event twice!

CompressL()

IMPORT_C void

CompressL

(

)

ConnectFsL(RFs *)

void

ConnectFsL

(

RFs *

aRfs

)

[private, inline]

Parameters

RFs * aRfs

Constants()

IMPORT_C CPbkConstants *

Constants

(

)

ConstructL(const TDesC , TBool, RFs )

void	ConstructL	(	const TDesC *	aFileName,
			TBool	aReplace,
			RFs *	aFs
		)	[private]

Parameters

const TDesC * aFileName
TBool aReplace
RFs * aFs

ContactNameFormat()

IMPORT_C MPbkContactNameFormat &

ContactNameFormat

(

)

const

CreateContactChangeNotifierL(MPbkContactDbObserver *)

IMPORT_C CPbkContactChangeNotifier *

CreateContactChangeNotifierL

(

MPbkContactDbObserver *

aObserver

)

Creates and returns a new CPbkContactChangeNotifier for the default contact database. The returned object attaches aObserver to this engine instance as long as the object exists.

CPbkContactChangeNotifier MPbkContactDbObserver

Parameters

MPbkContactDbObserver * aObserver

Observer to attach to this object.

CreateContactGroupL(const TDesC &, TBool)

IMPORT_C CContactGroup *	CreateContactGroupL	(	const TDesC &	aGroupLabel,
			TBool	aInTransaction = EFalse
		)

Creates a new contact group.

CContactDatabase::CreateContactGroupL

Parameters

const TDesC & aGroupLabel	Group name.
TBool aInTransaction = EFalse	See Symbian Contacts Model documentation for CContactDatabase::CreateContactGroupL documentation.

CreateContactIteratorLC(TBool)

IMPORT_C CPbkContactIter *

CreateContactIteratorLC

(

TBool

aUseMinimalRead = EFalse

)

Returns a Phonebook contact iterator. CPbkContactIter::NewL. CContactDatabase::ReadMinimalContactL

Parameters

TBool aUseMinimalRead = EFalse

If ETrue the iterator will use the Symbian Contacts model CContactDatabase::ReadMinimalContactL, EFalse will read all the contact fields. Default behaviour is to read all fields.

CreateDbConnectionL(const TDesC *, TBool, TInt &, TBool)

void	CreateDbConnectionL	(	const TDesC *	aFileName,
			TBool	aReplace,
			TInt &	aDbOpenError,
			TBool	aSettingsVisible
		)	[private, inline]

Parameters

const TDesC * aFileName
TBool aReplace
TInt & aDbOpenError
TBool aSettingsVisible

CreateEmptyContactL()

IMPORT_C CPbkContactItem *

CreateEmptyContactL

(

)

Returns a new contact card with default fields.

Database()

IMPORT_C CContactDatabase &

Database

(

)

Returns the underlying CContactDatabase object. Use only if this class's API is not enough for your purposes.

CContactDatabase

DeleteContactGroupL(TContactItemId, TBool)

IMPORT_C void	DeleteContactGroupL	(	TContactItemId	aContactId,
			TBool	aImmediateNotify = EFalse
		)

Deletes a contact group from the database. CContactDatabase::DeleteContactL

Parameters

TContactItemId aContactId	Contact group to be deleted.
TBool aImmediateNotify = EFalse	Send notification to observers immediately. NOTE: send immediately will result in observers (MPbkContactDbObserver) receiving the event twice!

DeleteContactL(TContactItemId, TBool)

IMPORT_C void	DeleteContactL	(	TContactItemId	aContactId,
			TBool	aImmediateNotify = EFalse
		)

Deletes a contact item from the database. CContactDatabase::DeleteContactL

Parameters

TContactItemId aContactId	Contact item to be deleted.
TBool aImmediateNotify = EFalse	Send notification to observers immediately. NOTE: send immediately will result in observers (MPbkContactDbObserver) receiving the event twice!

DeleteContactsL(const CContactIdArray &, TBool)

IMPORT_C void	DeleteContactsL	(	const CContactIdArray &	aContactIds,
			TBool	aImmediateNotify = EFalse
		)

Deletes multiple contact items from the database. CContactDatabase::DeleteContactsL

Parameters

const CContactIdArray & aContactIds	Contact items to be deleted.
TBool aImmediateNotify = EFalse	Send notification to observers immediately. NOTE: send immediately will result in observers (MPbkContactDbObserver) receiving the event twice!

DeleteContactsOnBackgroundL(const CContactIdArray &)

IMPORT_C void

DeleteContactsOnBackgroundL

(

const CContactIdArray &

aContactIds

)

Deletes multiple contacts from the database in an active object -driven asynchronous background process.

Parameters

const CContactIdArray & aContactIds

Contacts to delete.

DuplicateContactL(TContactItemId, TBool)

IMPORT_C TContactItemId	DuplicateContactL	(	TContactItemId	aId,
			TBool	aImmediateNotify = EFalse
		)

Duplicates a contact in the database.

Parameters

TContactItemId aId	Id of the contact to duplicate.
TBool aImmediateNotify = EFalse	Send notification to observers immediately. NOTE: send immediately will result in observers (MPbkContactDbObserver) receiving the event twice!

FieldsInfo()

IMPORT_C const CPbkFieldsInfo &

FieldsInfo

(

)

Returns the field type info array. CPbkFieldsInfo

FilteredContactsViewL(TInt)

IMPORT_C CContactViewBase &

FilteredContactsViewL

(

TInt

aFilter

)

Returns a contact view object containing all the contacts in the database that match a filter.

CContactViewBase

Parameters

TInt aFilter

Use CContactDatabase::TContactViewFilter.

FindAsyncL(const TDesC &, const CPbkFieldIdArray , MIdleFindObserver )

IMPORT_C CPbkIdleFinder *	FindAsyncL	(	const TDesC &	aText,
			const CPbkFieldIdArray *	aFieldTypes = NULL,
			MIdleFindObserver *	aObserver = NULL
		)

Searches all contacts in the database for aText asynchronously.

CContactDatabase::FindAsyncL. CPbkIdleFinder

Parameters

const TDesC & aText	Text to search.
const CPbkFieldIdArray * aFieldTypes = NULL	Phonebook fields types to at least include in the search. If NULL searches all fields. PLEASE NOTE: The find matches in most cases also other fields than those specified in aFieldTypes. Always loop through the returned contacts to check match in the required fields.
MIdleFindObserver * aObserver = NULL	Observer for this operation.

FindLC(const TDesC &, const CPbkFieldIdArray *)

IMPORT_C CContactIdArray *	FindLC	(	const TDesC &	aText,
			const CPbkFieldIdArray *	aFieldTypes = NULL
		)

Searches all contacts in the database for aText.

CContactDatabase::FindLC.

Parameters

const TDesC & aText	Text to search.
const CPbkFieldIdArray * aFieldTypes = NULL	Phonebook fields types to at least include in the search. If NULL searches all fields. PLEASE NOTE: The find matches in most cases also other fields than those specified in aFieldTypes. Always loop through the returned contacts to check match in the required fields.

FsSession()

IMPORT_C RFs &

FsSession

(

)

const

Returns an open file server session.

GetContactTitleL(const CPbkContactItem &)

IMPORT_C HBufC *

GetContactTitleL

(

const CPbkContactItem &

aItem

)

const

Gets a title text for a contact or localised text for unnamed contact if contact contains no title.

Parameters

const CPbkContactItem & aItem

Contact item for which to make the title.

GetContactTitleOrNullL(const MPbkFieldDataArray &)

IMPORT_C HBufC *

GetContactTitleOrNullL

(

const MPbkFieldDataArray &

aContactData

)

Similar to GetContactTitleL but returns NULL if contact contains no title. Uses the MPbkFieldDataArray interface to access the field content. CPbkContactEngine::GetContactTitleL

Parameters

const MPbkFieldDataArray & aContactData

The contact field data array.

GetSpeedDialFieldL(TInt, TDes &)

IMPORT_C TContactItemId	GetSpeedDialFieldL	(	TInt	aSpeedDialPosition,
			TDes &	aPhoneNumber
		)	const

Returns a speed dial contact.

CContactDatabase::GetSpeedDialFieldL.

Parameters

TInt aSpeedDialPosition	Speed dial position number.
TDes & aPhoneNumber	Phone number

HandleDatabaseEventL(TContactDbObserverEvent)

void

HandleDatabaseEventL

(

TContactDbObserverEvent

aEvent

)

[private]

Distributes CContactDatabase observer events in Phonebook.

Parameters

TContactDbObserverEvent aEvent

IsSpeedDialAssigned(const CPbkContactItem &, TInt)

IMPORT_C TBool	IsSpeedDialAssigned	(	const CPbkContactItem &	aItem,
			TInt	aFieldIndex
		)	const

Returns ETrue if this field has been assigned a speed dial position.

Parameters

const CPbkContactItem & aItem	contact Item to check for speed dial.
TInt aFieldIndex	Index of the field to check. This is an index into aItem.CardFields().

IsTitleField(TPbkFieldId)

IMPORT_C TBool

IsTitleField

(

TPbkFieldId

aFieldId

)

const

Returns ETrue if field is one of the fields used in building the contact title.

GetContactTitleL GetContactTitleOrNullL

Parameters

TPbkFieldId aFieldId

The id of the field.

MatchPhoneNumberL(const TDesC &, const TInt)

IMPORT_C CContactIdArray *	MatchPhoneNumberL	(	const TDesC &	aNumber,
			const TInt	aMatchLengthFromRight
		)

Call-through for new Phone number matching function in 6.2 version of class CContactDatabase. If you don't need any other functionality from CPbkContactEngine than this consider using the CContactDatabase API directly. See Symbian Contacts Model documentation for CContactDatabase::MatchPhoneNumberL use.

CContactDatabase::MatchPhoneNumberL(const TDesC&,const TInt)

Parameters

const TDesC & aNumber
const TInt aMatchLengthFromRight

NameDisplayOrderL()

IMPORT_C TPbkNameOrder

NameDisplayOrderL

(

)

NameSeparator()

IMPORT_C TChar

NameSeparator

(

)

const

NewL(RFs *)

IMPORT_C CPbkContactEngine *

NewL

(

RFs *

aFs = NULL

)

[static]

Creates a new Phonebook engine object and connects to the default contact database. If the default database does not exist it is created.

Exceptions

KErrCorrupt

if the database is corrupted.

Parameters

RFs * aFs = NULL

An open file server connection. If !=NULL aFs is used instead of a locally created RFs connection. aFs must remain connected for the lifetime of the returned object.

NewL(const TDesC &, TBool, RFs *)

IMPORT_C CPbkContactEngine *	NewL	(	const TDesC &	aFileName,
			TBool	aReplace = EFalse,
			RFs *	aFs = NULL
		)	[static]

Parameters

const TDesC & aFileName
TBool aReplace = EFalse
RFs * aFs = NULL

OpenContactGroupL(TContactItemId)

IMPORT_C CContactGroup *

OpenContactGroupL

(

TContactItemId

aId

)

Opens a Contact group for modification.

CContactDatabase::OpenContactL

Parameters

TContactItemId aId

Groups id

OpenContactGroupLCX(TContactItemId)

IMPORT_C CContactGroup *

OpenContactGroupLCX

(

TContactItemId

aId

)

Opens a Contact group for modification. Pushes the returned contact group object and a lock item on the cleanup stack.

CContactDatabase::OpenContactLX

Parameters

TContactItemId aId

Groups id

OpenContactL(TContactItemId)

IMPORT_C CPbkContactItem *

OpenContactL

(

TContactItemId

aContactId

)

Opens a contact and returns a phonebook contact item. CContactDatabase::OpenContactL

Parameters

TContactItemId aContactId

Contact item id to be opened.

OpenContactLCX(TContactItemId)

IMPORT_C CPbkContactItem *

OpenContactLCX

(

TContactItemId

aContactId

)

Same as OpenContactL, but leaves a lock record AND the opened contact object on the cleanup stack. Use CleanupStack::PopAndDestroy(2) to close the contact and destroy the returned object. First pop pops the contact object and second the lock object. CContactDatabase::OpenContactLX

Parameters

TContactItemId aContactId

Contact item id to open.

ReadContactGroupL(TContactItemId)

IMPORT_C CContactGroup *

ReadContactGroupL

(

TContactItemId

aId

)

Reads a Contact group.

CContactDatabase::ReadContactL

Parameters

TContactItemId aId

Group id.

ReadContactL(TContactItemId, const CPbkFieldIdArray *)

IMPORT_C CPbkContactItem *	ReadContactL	(	TContactItemId	aContactId,
			const CPbkFieldIdArray *	aFieldTypes = NULL
		)

Reads a contact and returns a phonebook contact item.

CContactDatabase::ReadContactL

Parameters

TContactItemId aContactId	Contact item id to be read.
const CPbkFieldIdArray * aFieldTypes = NULL	Array of types of fields to read in, all fields are read if NULL (which is default). NOTE: when using this parameter ReadContactL may return more fields than expected; for example if aFieldTypes contains any phonenumber the method may return all phone number fields of the contact.

ReadContactLC(TContactItemId, const CPbkFieldIdArray *)

IMPORT_C CPbkContactItem *	ReadContactLC	(	TContactItemId	aContactId,
			const CPbkFieldIdArray *	aFieldTypes = NULL
		)

Same as ReadContactL, but leaves the returned contact item on the cleanup stack.

Parameters

TContactItemId aContactId	Contact item id to be read.
const CPbkFieldIdArray * aFieldTypes = NULL	Array of types of fields to read in, all fields are read if NULL (which is default). NOTE: when using this parameter ReadContactL may return more fields than expected; for example if aFieldTypes contains any phonenumber the method may return all phone number fields of the contact.

ReadMinimalContactLC(TContactItemId)

IMPORT_C CPbkContactItem *

ReadMinimalContactLC

(

TContactItemId

aContactId

)

Same as ReadContactLC but reads only minimal information. See Symbian Contacts Model documentation for definition of "minimal" in this case.

CContactDatabase::ReadMinimalContactL

Parameters

TContactItemId aContactId

Contact item id to be read.

ReadResourcesL(TBool &)

void

ReadResourcesL

(

TBool &

aSettingsVisibility

)

[private, inline]

Parameters

TBool & aSettingsVisibility

RemoveContactFromGroupL(TContactItemId, TContactItemId)

IMPORT_C void	RemoveContactFromGroupL	(	TContactItemId	aItemId,
			TContactItemId	aGroupId
		)

Removes a contact from a group

CContactDatabase::RemoveContactFromGroupL

Parameters

TContactItemId aItemId	Contact to be removed from group.
TContactItemId aGroupId	Group where the contact will be removed from.

RemoveObserver(MPbkContactDbObserver *)

void

RemoveObserver

(

MPbkContactDbObserver *

aObserver

)

[private]

Parameters

MPbkContactDbObserver * aObserver

RemoveSpeedDialFieldL(TContactItemId, TInt)

IMPORT_C void	RemoveSpeedDialFieldL	(	TContactItemId	aContactId,
			TInt	aSpeedDialPosition
		)

Removes a speed dial from a contact.

CContactDatabase::RemoveSpeedDialFieldL.

Parameters

TContactItemId aContactId	Contact item to remove the speed dial from.
TInt aSpeedDialPosition	Speed dial position number to remove.

ReplaceL(RFs *)

IMPORT_C CPbkContactEngine *

ReplaceL

(

RFs *

aFs = NULL

)

[static]

Replaces the default contact database and connects to it. See Symbian Contacs model documentation for CContactDatabase::ReplaceL for possible leave codes. PLEASE NOTE: all data in the existing database will be lost!

CContactDatabase::ReplaceL

Parameters

RFs * aFs = NULL

An open file server connection. If !=NULL aFs is used instead of a locally created RFs connection. aFs must remain connected for the lifetime of the returned object.

SendEventToAllObservers(const TContactDbObserverEvent &)

void

SendEventToAllObservers

(

const TContactDbObserverEvent &

aEvent

)

[private]

Parameters

const TContactDbObserverEvent & aEvent

SendImmidiateEventToAllObservers(TContactDbObserverEventType, TContactItemId, TBool)

void	SendImmidiateEventToAllObservers	(	TContactDbObserverEventType	aEventType,
			TContactItemId	aContactId,
			TBool	aSendEvent
		)	[private]

Parameters

TContactDbObserverEventType aEventType
TContactItemId aContactId
TBool aSendEvent

SetCompressUi(MPbkCompressUi *)

IMPORT_C void

SetCompressUi

(

MPbkCompressUi *

aCompressiUi

)

Parameters

MPbkCompressUi * aCompressiUi

SetFieldAsSpeedDialL(CPbkContactItem &, TInt, TInt)

IMPORT_C void	SetFieldAsSpeedDialL	(	CPbkContactItem &	aItem,
			TInt	aFieldIndex,
			TInt	aSpeedDialPosition
		)

Sets a speed dial to a contact field.

CContactDatabase::SetFieldAsSpeedDialL

Parameters

CPbkContactItem & aItem	Contact item to add speed dial to.
TInt aFieldIndex	Field index to add Speed dial to.
TInt aSpeedDialPosition	Speed dial position number to set to the field.

SetNameDisplayOrderL(TPbkNameOrder)

IMPORT_C void

SetNameDisplayOrderL

(

TPbkNameOrder

aNameOrder

)

Parameters

TPbkNameOrder aNameOrder

SetNameSeparatorL(TChar)

IMPORT_C void

SetNameSeparatorL

(

TChar

aSeparator

)

Parameters

TChar aSeparator

SortOrderManager()

const CPbkSortOrderManager &

SortOrderManager

(

)

const

Static()

IMPORT_C CPbkContactEngine *

Static

(

)

[static]

Returns the global Phonebook engine instance, NULL if no instance created yet. Note1: Uses thread local storage (TLS), which is slow. Cache the returned pointer if it is used more than one time! Note2: Only the first engine instance created in calling thread can be accessed with this function.

UnnamedTitle()

IMPORT_C const TDesC &

UnnamedTitle

(

)

const

Returns the localised title text to use for unnamed contacts.

doDeleteContactL(TContactItemId)

void

doDeleteContactL

(

TContactItemId

aContactId

)

[private]

Parameters

TContactItemId aContactId

Member Enumerations Documentation

Enum TPbkNameOrder

Enumerators

EPbkNameOrderLastNameFirstName = 0
EPbkNameOrderFirstNameLastName
EPbkNameOrderNotDefined	undefined name order

Member Data Documentation

CContactDbConnection * iDbConnection

CContactDbConnection *

iDbConnection

[private]

TUid iDtorIDKey

TUid

iDtorIDKey

[private]

CPbkEngineExtension * iExtension

CPbkEngineExtension *

iExtension

[private]

TInt iFreeSpaceRequiredToDelete

TInt

iFreeSpaceRequiredToDelete

[private]

RFs iFs

RFs

iFs

[private]

CArrayPtr< MPbkContactDbObserver > * iObservers

CArrayPtr< MPbkContactDbObserver > *

iObservers

[private]

RFs iOwnFs

RFs

iOwnFs

[private]

CPbkConstants * iPbkConstants

CPbkConstants *

iPbkConstants

[private]

CPbkFieldsInfo * iPbkFieldsInfo

CPbkFieldsInfo *

iPbkFieldsInfo

[private]

CPbkSINDHandlerInterface * iSINDHandler

CPbkSINDHandlerInterface *

iSINDHandler

[private]

TChar iSeparator

TChar

iSeparator

[private]

RSharedDataClient * iSharedDataClient

RSharedDataClient *

iSharedDataClient

[private]

TBool iUseSeparator

TBool

iUseSeparator

[private]

CPbkContactEngine Class Reference

Inherits from

Nested Classes and Structures

Constructor & Destructor Documentation

CPbkContactEngine()

~CPbkContactEngine()

Member Functions Documentation

AddContactToGroupL(TContactItemId, TContactItemId)

Parameters

AddNewContactL(CPbkContactItem &, TBool)

Parameters

AddObserverL(MPbkContactDbObserver *)

Parameters

AllContactsView()

AllGroupsViewL()

CancelCompress()

CheckCompress()

CheckFileSystemSpaceAndCompressL()

CloseContactL(TContactItemId)

Parameters

CommitContactGroupL(CContactGroup &, TBool)

Parameters

CommitContactL(CPbkContactItem &, TBool)

Parameters

CompressL()

ConnectFsL(RFs *)

Parameters

Constants()

ConstructL(const TDesC *, TBool, RFs *)

Parameters

ContactNameFormat()

CreateContactChangeNotifierL(MPbkContactDbObserver *)

Parameters

CreateContactGroupL(const TDesC &, TBool)

Parameters

CreateContactIteratorLC(TBool)

Parameters

CreateDbConnectionL(const TDesC *, TBool, TInt &, TBool)

Parameters

CreateEmptyContactL()

Database()

DeleteContactGroupL(TContactItemId, TBool)

Parameters

DeleteContactL(TContactItemId, TBool)

Parameters

DeleteContactsL(const CContactIdArray &, TBool)

Parameters

DeleteContactsOnBackgroundL(const CContactIdArray &)

Parameters

DuplicateContactL(TContactItemId, TBool)

Parameters

FieldsInfo()

FilteredContactsViewL(TInt)

Parameters

FindAsyncL(const TDesC &, const CPbkFieldIdArray *, MIdleFindObserver *)

Parameters

FindLC(const TDesC &, const CPbkFieldIdArray *)

Parameters

FsSession()

GetContactTitleL(const CPbkContactItem &)

Parameters

GetContactTitleOrNullL(const MPbkFieldDataArray &)

Parameters

GetSpeedDialFieldL(TInt, TDes &)

Parameters

HandleDatabaseEventL(TContactDbObserverEvent)

Parameters

IsSpeedDialAssigned(const CPbkContactItem &, TInt)

Parameters

IsTitleField(TPbkFieldId)

Parameters

MatchPhoneNumberL(const TDesC &, const TInt)

Parameters

NameDisplayOrderL()

NameSeparator()

NewL(RFs *)

Parameters

NewL(const TDesC &, TBool, RFs *)

Parameters

OpenContactGroupL(TContactItemId)

ConstructL(const TDesC , TBool, RFs )

FindAsyncL(const TDesC &, const CPbkFieldIdArray , MIdleFindObserver )