Collapse all Symbian^3 Product Developer Library

RPsSession Class Reference

class RPsSession : public RSessionBase

Client side interface for predictive search server.

Inherits from

RPsSession
- RSessionBase
  - RHandleBase

Public Member Functions
	RPsSession()
void	CancelSearch()
void	ChangeSortOrderL(const TDes8 &)
TInt	Connect()
void	GetAdaptiveGridL(const TDesC8 &, const TBool, TDes &)
void	GetDataOrderL(const TDes8 &, TPtr8)
void	GetSortOrderL(const TDes8 &, TPtr8)
void	IsLanguageSupportedL(const TDes8 &, TPtr8)
void	SearchL(const TDes8 &, TPtr8, TRequestStatus &)
void	SearchL(const TDes8 &, const TDes8 &, TPtr8)
void	SearchMatchStringL(const TDes8 &, const TDes8 &, TDes &)
void	SendNewBufferL(TPtr8, TRequestStatus &)
void	SetSearchSettingsL(const TDes8 &)
void	ShutdownServerL()
TVersion	Version()

Inherited Functions
	RHandleBase::Attributes()const
	RHandleBase::BTraceId()const
	RHandleBase::Close()
	RHandleBase::DoExtendedClose()
	RHandleBase::Duplicate(const RThread &,TOwnerType)
	RHandleBase::FullName()const
	RHandleBase::FullName(TDes &)const
	RHandleBase::Handle()const
	RHandleBase::HandleInfo(THandleInfo *)
	RHandleBase::Name()const
	RHandleBase::NotifyDestruction(TRequestStatus &)
	RHandleBase::Open(const TFindHandleBase &,TOwnerType)
	RHandleBase::OpenByName(const TDesC &,TOwnerType,TInt)
	RHandleBase::RHandleBase()
	RHandleBase::RHandleBase(TInt)
	RHandleBase::SetHandle(TInt)
	RHandleBase::SetHandleNC(TInt)
	RSessionBase::CreateSession(RServer2,const TVersion &)
	RSessionBase::CreateSession(RServer2,const TVersion &,TInt)
	RSessionBase::CreateSession(RServer2,const TVersion &,TInt,TIpcSessionType,const TSecurityPolicy ,TRequestStatus )
	RSessionBase::CreateSession(const TDesC &,const TVersion &)
	RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt)
	RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt,TIpcSessionType,const TSecurityPolicy ,TRequestStatus )
	RSessionBase::CreateSession(const TDesC &,const TVersion &,TInt,TRequestStatus *)
	RSessionBase::Open(RMessagePtr2,TInt,TOwnerType)
	RSessionBase::Open(RMessagePtr2,TInt,const TSecurityPolicy &,TOwnerType)
	RSessionBase::Open(TInt,TOwnerType)
	RSessionBase::Open(TInt,const TSecurityPolicy &,TOwnerType)
	RSessionBase::Send(TInt)const
	RSessionBase::Send(TInt,const TIpcArgs &)const
	RSessionBase::SendReceive(TInt)const
	RSessionBase::SendReceive(TInt,TRequestStatus &)const
	RSessionBase::SendReceive(TInt,const TIpcArgs &)const
	RSessionBase::SendReceive(TInt,const TIpcArgs &,TRequestStatus &)const
	RSessionBase::SetReturnedHandle(TInt)
	RSessionBase::SetReturnedHandle(TInt,RHandleBase &)
	RSessionBase::SetReturnedHandle(TInt,const TSecurityPolicy &)
	RSessionBase::ShareAuto()
	RSessionBase::ShareProtected()

Inherited Enumerations
	RHandleBase:TAttributes
	RSessionBase:TAttachMode

Private Attributes
TPtr8	iResultsBufferPtr
TPtrC8	iSearchQueryBufferPtr

Inherited Attributes
	RHandleBase::iHandle

Constructor & Destructor Documentation

RPsSession()

RPsSession

(

)

RPcsSession. Constructor

Member Functions Documentation

CancelSearch()

void

CancelSearch

(

)

CancelSearchL. Cancels a pending search request.

ChangeSortOrderL(const TDes8 &)

void

ChangeSortOrderL

(

const TDes8 &

aInput

)

ChangeSortOrderL Sends a request to PS server to set the sort order of fields for a data store.

Parameters

const TDes8 & aInput

Data store + Sort Order values.

Connect()

TInt

Connect

(

)

Connect. Connects to the predictive search server

GetAdaptiveGridL(const TDesC8 &, const TBool, TDes &)

void	GetAdaptiveGridL	(	const TDesC8 &	aURIs,
			const TBool	aCompanyName,
			TDes &	aResultsBuffer
		)

GetAdaptiveGridL This is a support method for Adaptive Search functionality. As Predictive Search Engine is well suited for keeping an maintaining data structures related to contacts and updated according to contacts additions/modifications/deletions, like it is done already in Predictive Search Engine.

Parameters

const TDesC8 & aURIs	The data store URIs.
const TBool aCompanyName	The info if Company Name is required.
TDes & aResultsBuffer

GetDataOrderL(const TDes8 &, TPtr8)

void	GetDataOrderL	(	const TDes8 &	aURI,
			TPtr8	aResultsBuffer
		)

GetDataOrderL Sends a request to PS server to get the data fields supported for a data store.

Parameters

const TDes8 & aURI	Data store identifier.
TPtr8 aResultsBuffer	Pointer to the results buffer.

GetSortOrderL(const TDes8 &, TPtr8)

void	GetSortOrderL	(	const TDes8 &	aURI,
			TPtr8	aResultsBuffer
		)

GetSortOrderL Sends a request to PS server to get the sort order of fields supported for a data store.

Parameters

const TDes8 & aURI	Data store identifier.
TPtr8 aResultsBuffer	Pointer to the results buffer.

IsLanguageSupportedL(const TDes8 &, TPtr8)

void	IsLanguageSupportedL	(	const TDes8 &	aLanguage,
			TPtr8	aResultsBuffer
		)

IsLanguageSupportedL Sends a request to PS server to decide if the language variant is supported or not

Parameters

const TDes8 & aLanguage	The language id info.
TPtr8 aResultsBuffer	Pointer to the initial results buffer.

SearchL(const TDes8 &, TPtr8, TRequestStatus &)

void	SearchL	(	const TDes8 &	aSearchQuery,
			TPtr8	aResultsBuffer,
			TRequestStatus &	aStatus
		)

SearchL. Initiates a predictive search request to the server.

Parameters

const TDes8 & aSearchQuery	The search query.
TPtr8 aResultsBuffer	Pointer to the initial results buffer.
TRequestStatus & aStatus	Holds the completion status of request.

SearchL(const TDes8 &, const TDes8 &, TPtr8)

void	SearchL	(	const TDes8 &	aSearchQuery,
			const TDes8 &	aSearchData,
			TPtr8	aResultsBuffer
		)

SearchL. Initiates a predictive search request to the server.

Parameters

const TDes8 & aSearchQuery	The search query.
const TDes8 & aSearchData	The search data.
TPtr8 aResultsBuffer	Pointer to the initial results buffer.

SearchMatchStringL(const TDes8 &, const TDes8 &, TDes &)

void	SearchMatchStringL	(	const TDes8 &	aSearchQuery,
			const TDes8 &	aSearchData,
			TDes &	aResultsBuffer
		)

SearchMatchStringL. Initiates a predictive search request to the server with result as string.

Parameters

const TDes8 & aSearchQuery	The search query.
const TDes8 & aSearchData	The search data.
TDes & aResultsBuffer	Pointer to the initial results buffer.

SendNewBufferL(TPtr8, TRequestStatus &)

void	SendNewBufferL	(	TPtr8	aResultsBuffer,
			TRequestStatus &	aStatus
		)

SendNewBufferL. Send a new buffer to server if a overflow occurs.

Parameters

TPtr8 aResultsBuffer	Pointer to the new results buffer.
TRequestStatus & aStatus	Holds the completion status of request.

SetSearchSettingsL(const TDes8 &)

void

SetSearchSettingsL

(

const TDes8 &

aSettings

)

SetSearchSettingsL. Send the search settings (databases/ display fields) to the server.

Parameters

const TDes8 & aSettings

The search settings.

ShutdownServerL()

void

ShutdownServerL

(

)

Shuts down the predictive search server

Version()

TVersion

Version

(

)

const

Version. Returns the version number of predictive search server

Member Data Documentation

TPtr8 iResultsBufferPtr

TPtr8

iResultsBufferPtr

[private]

iResultsBufferPtr. Pointer to the buffer holding search results

TPtrC8 iSearchQueryBufferPtr

TPtrC8

iSearchQueryBufferPtr

[private]

iSearchQueryBufferPtr. Pointer to the buffer holding search query.