Symbian^3 Application Developer Library >

MLplCollection Class Reference

class MLplCollection

This interface provides a simplified way of querying the database. The result of the query is typically an array of the contact IDs satisfying the given criteria. For example, IDs of all the contacts changed since the given date.

Public Member Functions
CContactIdArray * CollectionL ( TLplViewType , TTime , const TDesC &)
void ConstructBitwiseFlagsFromTextDef ( TInt &, TInt &, const CContactTextDef *)
TInt ContactCountL ()
TBool ContactMatchesHintFieldL ( TInt , TContactItemId )
CContactIdArray * FilterDatabaseL ( CCntFilter &)
void FindAsyncInitL (const TDesC &, CContactItemFieldDef *)
CContactIdArray * FindAsyncL ( TBool &, TUint )
void FindAsyncTextDefInitL (const CDesCArray &, CContactTextDef *)
CContactIdArray * FindL (const TDesC &, const CContactItemFieldDef *, TUint )
CContactIdArray * MatchPhoneNumberL (const TDesC &, const TInt )
void Reset ()
TBool SeekContactL ( TContactItemId , TContactItemId &, TUid &, TBool &)
TBool UsesIdentityFieldsOnly ( TInt )
Public Member Enumerations
enum TLplViewType {
EFilter , EChangedSince , EFindInIdFields , EFindInEmail , EFindInAll , EFindType , EFindGuid , EPhoneMatch , EViewData , EUnfiled , EDeleted , ESortNoText , ESortWithText , EMatchPhoneNos
}

Member Functions Documentation

CollectionL(TLplViewType, TTime, const TDesC &)

CContactIdArray * CollectionL ( TLplViewType aViewType,
TTime aTime = 0,
const TDesC & aGuid =  KNullDesC
) [pure virtual]

Parameters

TLplViewType aViewType
TTime aTime = 0
const TDesC & aGuid =  KNullDesC

ConstructBitwiseFlagsFromTextDef(TInt &, TInt &, const CContactTextDef *)

void ConstructBitwiseFlagsFromTextDef ( TInt & aFindFlags,
TInt & aIdentityColumnsCount,
const CContactTextDef * aTextDef
) [pure virtual]

Parameters

TInt & aFindFlags
TInt & aIdentityColumnsCount
const CContactTextDef * aTextDef

ContactCountL()

TInt ContactCountL ( ) [pure virtual]

ContactMatchesHintFieldL(TInt, TContactItemId)

TBool ContactMatchesHintFieldL ( TInt aBitWiseFilter,
TContactItemId aContactId
) [pure virtual]

Parameters

TInt aBitWiseFilter
TContactItemId aContactId

FilterDatabaseL(CCntFilter &)

CContactIdArray * FilterDatabaseL ( CCntFilter & aFilter ) [pure virtual]

Parameters

CCntFilter & aFilter

FindAsyncInitL(const TDesC &, CContactItemFieldDef *)

void FindAsyncInitL ( const TDesC & aText,
CContactItemFieldDef * aFieldDef
) [pure virtual]

Parameters

const TDesC & aText
CContactItemFieldDef * aFieldDef

FindAsyncL(TBool &, TUint)

CContactIdArray * FindAsyncL ( TBool & aMoreToGo,
TUint aSessionId
) [pure virtual]

Parameters

TBool & aMoreToGo
TUint aSessionId

FindAsyncTextDefInitL(const CDesCArray &, CContactTextDef *)

void FindAsyncTextDefInitL ( const CDesCArray & aWords,
CContactTextDef * aTextDef
) [pure virtual]

Parameters

const CDesCArray & aWords
CContactTextDef * aTextDef

FindL(const TDesC &, const CContactItemFieldDef *, TUint)

CContactIdArray * FindL ( const TDesC & aText,
const CContactItemFieldDef * aFieldDef,
TUint aSessionId
) [pure virtual]

Parameters

const TDesC & aText
const CContactItemFieldDef * aFieldDef
TUint aSessionId

MatchPhoneNumberL(const TDesC &, const TInt)

CContactIdArray * MatchPhoneNumberL ( const TDesC & aNumber,
const TInt aMatchLengthFromRight
) [pure virtual]

Parameters

const TDesC & aNumber
const TInt aMatchLengthFromRight

Reset()

void Reset ( ) [pure virtual]

SeekContactL(TContactItemId, TContactItemId &, TUid &, TBool &)

TBool SeekContactL ( TContactItemId aReqId,
TContactItemId & aId,
TUid & aContactType,
TBool & aDeleted
) [pure virtual]

Parameters

TContactItemId aReqId
TContactItemId & aId
TUid & aContactType
TBool & aDeleted

UsesIdentityFieldsOnly(TInt)

TBool UsesIdentityFieldsOnly ( TInt aFindFlags ) [pure virtual]

Parameters

TInt aFindFlags

Member Enumerations Documentation

Enum TLplViewType

Enumerators

EFilter
EChangedSince
EFindInIdFields
EFindInEmail
EFindInAll
EFindType
EFindGuid
EPhoneMatch
EViewData
EUnfiled
EDeleted
ESortNoText
ESortWithText
EMatchPhoneNos

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.