RContactRemoteView Class Reference

#include <app/cntviewbase.h>

class RContactRemoteView : public RSubSessionBase, public RSubSessionBase

Inherits from

Public Member Functions
RContactRemoteView()
HBufC *AllFieldsLC(TInt, const TDesC &)
TContactItemId AtL(TInt)
TInt CancelRequestViewEvent()
voidChangeSortOrderL(const RContactViewSortOrder &)
voidClose()
CViewContact *ContactAtL(TInt)
TContactViewPreferences ContactViewPreferencesL()
voidContactsMatchingCriteriaL(const MDesCArray &, RPointerArray< CViewContact > &, TBool, TUid)
voidContactsMatchingCriteriaL(const MDesC16Array &, RPointerArray< CViewContact > &, TBool, TUid)
TInt CountL()
TInt FindL(TContactItemId)
voidGetContactIdsL(const CArrayFix< TInt > &, CContactIdArray &)
voidGetContactsMatchingFilterL(TInt, RArray< TContactIdWithMapping > &)
voidGetSortOrderL(RContactViewSortOrder &)
TUid GetViewSortPluginImplUidL()
voidOpenL(const CContactDatabase &, const RContactViewSortOrder &, TContactViewPreferences, const TUid &, const TDesC8 &)
voidOpenL(const CContactDatabase &, const TDesC &, const RContactViewSortOrder &, TContactViewPreferences, const TUid &, const TDesC8 &)
voidReOpenL(const CContactDatabase &)
voidRequestViewEvent(TPckgBuf< TContactViewEvent > &, TRequestStatus &)
const RContactViewSortOrder &SortOrderL()
Inherited Functions
RSubSessionBase::CloseSubSession(TInt)
RSubSessionBase::CreateAutoCloseSubSession(RSessionBase &,TInt,const TIpcArgs &)
RSubSessionBase::CreateSubSession(const RSessionBase &,TInt)
RSubSessionBase::CreateSubSession(const RSessionBase &,TInt,const TIpcArgs &)
RSubSessionBase::RSubSessionBase()
RSubSessionBase::Send(TInt)const
RSubSessionBase::Send(TInt,const TIpcArgs &)const
RSubSessionBase::SendReceive(TInt)const
RSubSessionBase::SendReceive(TInt,TRequestStatus &)const
RSubSessionBase::SendReceive(TInt,const TIpcArgs &)const
RSubSessionBase::SendReceive(TInt,const TIpcArgs &,TRequestStatus &)const
RSubSessionBase::Session()const
RSubSessionBase::SubSessionHandle()const

Detailed Description

This class is used internally by remote contact views as the handle to the server side view object.

See also: CContactRemoteViewBase

Constructor & Destructor Documentation

RContactRemoteView ( )

RContactRemoteView()

RContactRemoteView constructor.

Member variables must be initialised (zero'd) in the constructor since RContactRemoteView does not derive from CBase.

Member Function Documentation

AllFieldsLC ( TInt, const TDesC & )

HBufC *AllFieldsLC(TIntaIndex,
const TDesC &aSeparator
)const
Capability
ReadUserData

AtL ( TInt )

TContactItemId AtL(TIntaIndex)const
Capability
ReadUserData

CancelRequestViewEvent ( )

TInt CancelRequestViewEvent()
Capability
None

ChangeSortOrderL ( const RContactViewSortOrder & )

voidChangeSortOrderL(const RContactViewSortOrder &aSortOrder)
Capability
ReadUserData

Close ( )

voidClose()
Capability
None

ContactAtL ( TInt )

CViewContact *ContactAtL(TIntaIndex)
Returns the contact item at the specified index into the view.
Parameters
aIndexIndex
Capability
ReadUserData

ContactViewPreferencesL ( )

TContactViewPreferences ContactViewPreferencesL()
Capability
ReadUserData

ContactsMatchingCriteriaL ( const MDesCArray &, RPointerArray< CViewContact > &, TBool, TUid )

voidContactsMatchingCriteriaL(const MDesCArray &aFindWords,
RPointerArray< CViewContact > &aMatchedContacts,
TBoolaPrefixSearch,
TUidaUid
)

Searches all contact items in the view for fields that contain the search strings specified.

Parameters
aFindWordsA descriptor array containing one or more search strings
aMatchedContactsOn return, an array of matching contact items
Capability
ReadUserData

ContactsMatchingCriteriaL ( const MDesC16Array &, RPointerArray< CViewContact > &, TBool, TUid )

voidContactsMatchingCriteriaL(const MDesC16Array &aFindWords,
RPointerArray< CViewContact > &aMatchedContacts,
TBoolaPrefixSearch,
TUidaUid
)

CountL ( )

TInt CountL()const
Capability
ReadUserData

FindL ( TContactItemId )

TInt FindL(TContactItemIdaId)const
Capability
ReadUserData

GetContactIdsL ( const CArrayFix< TInt > &, CContactIdArray & )

voidGetContactIdsL(const CArrayFix< TInt > &aIndexes,
CContactIdArray &aContactIds
)
Convert between view indexes and contact ids. This method makes the request to the server.
Capability
ReadUserData

GetContactsMatchingFilterL ( TInt, RArray< TContactIdWithMapping > & )

voidGetContactsMatchingFilterL(TIntaFilter,
RArray< TContactIdWithMapping > &aMatchingContacts
)

Requests an array of contact IDs from the server-side view which match the filter provided by the client.

Parameters
aFilterFilter supplied by client
aMatchingContactsArray of contacts which match the filter
Capability
ReadUserData

GetSortOrderL ( RContactViewSortOrder & )

voidGetSortOrderL(RContactViewSortOrder &aSortOrder)
Capability
ReadUserData

GetViewSortPluginImplUidL ( )

TUid GetViewSortPluginImplUidL()const

OpenL ( const CContactDatabase &, const RContactViewSortOrder &, TContactViewPreferences, const TUid &, const TDesC8 & )

voidOpenL(const CContactDatabase &aDb,
const RContactViewSortOrder &aSortOrder,
TContactViewPreferencesaContactTypes,
const TUid &aSortPluginImplUid,
const TDesC8 &aSortPluginName
)
Capability
ReadUserData

OpenL ( const CContactDatabase &, const TDesC &, const RContactViewSortOrder &, TContactViewPreferences, const TUid &, const TDesC8 & )

voidOpenL(const CContactDatabase &aDb,
const TDesC &aName,
const RContactViewSortOrder &aSortOrder,
TContactViewPreferencesaContactTypes,
const TUid &aSortPluginImplUid,
const TDesC8 &aSortPluginName
)
Capability
ReadUserData

ReOpenL ( const CContactDatabase & )

voidReOpenL(const CContactDatabase &aDb)
Reopens contacts view (used when cnt server was terminated)
Parameters
aDbReference to contact database used to create views
Capability
ReadUserData

RequestViewEvent ( TPckgBuf< TContactViewEvent > &, TRequestStatus & )

voidRequestViewEvent(TPckgBuf< TContactViewEvent > &aEvent,
TRequestStatus &aStatus
)
Capability
ReadUserData

SortOrderL ( )

const RContactViewSortOrder &SortOrderL()
Capability
ReadUserData