Collapse all Symbian^3 Product Developer Library

CSearchClientSession Class Reference

class CSearchClientSession : public CBase

This class represents a client side session to search framework. This class is used by the Search UI.

searchclient.lib

Inherits from

CSearchClientSession
- CBase

Public Member Functions
	~CSearchClientSession()
IMPORT_C void	CancelGetResults()
IMPORT_C void	CancelSearch()
IMPORT_C HBufC8 *	GetLaunchInfoL(const CSearchDocumentId &)
IMPORT_C void	GetResultsL(const RPointerArray< CSearchDocumentId > &, MSearchResultRetrieveObserver &)
IMPORT_C void	GetSupportedContentL(RPointerArray< CSearchContent > &, TUid)
IMPORT_C void	GetSupportedServicesL(RArray< TUid > &)
IMPORT_C void	LaunchApplicationL(const CSearchDocumentId &)
IMPORT_C CSearchClientSession *	NewL()
IMPORT_C void	SearchL(const CSearchQuery &, MSearchQueryObserver &, const TSearchThreshold &)

Private Member Functions
	CSearchClientSession()
void	ConstructL()

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()

Private Attributes
CSearchClientSessionImp *	iSessionImp

Constructor & Destructor Documentation

CSearchClientSession()

CSearchClientSession

(

)

[private]

Constructor.

~CSearchClientSession()

~CSearchClientSession

(

)

[virtual]

Destructor

Member Functions Documentation

CancelGetResults()

IMPORT_C void

CancelGetResults

(

)

CancelSearch()

IMPORT_C void

CancelSearch

(

)

ConstructL()

void

ConstructL

(

)

[private]

2nd phase constructor.

GetLaunchInfoL(const CSearchDocumentId &)

IMPORT_C HBufC8 *

GetLaunchInfoL

(

const CSearchDocumentId &

aDocumentID

)

Get launch infor of a file to be opened.

Parameters

const CSearchDocumentId & aDocumentID

GetResultsL(const RPointerArray< CSearchDocumentId > &, MSearchResultRetrieveObserver &)

IMPORT_C void	GetResultsL	(	const RPointerArray< CSearchDocumentId > &	aResultIDArray,
			MSearchResultRetrieveObserver &	aObserver
		)

Gets the search heavy results.

Parameters

const RPointerArray< CSearchDocumentId > & aResultIDArray	- The array of document ids.
MSearchResultRetrieveObserver & aObserver	- Pointer to the observer through which the results are returned.

GetSupportedContentL(RPointerArray< CSearchContent > &, TUid)

IMPORT_C void	GetSupportedContentL	(	RPointerArray< CSearchContent > &	aContent,
			TUid	aServiceId
		)

Function returning a list of support content types that can be searched by the engine.

: aContent - On return, contains the array of supported content types.

Parameters

RPointerArray< CSearchContent > & aContent
TUid aServiceId

GetSupportedServicesL(RArray< TUid > &)

IMPORT_C void

GetSupportedServicesL

(

RArray< TUid > &

aServiceIdArray

)

Gets supported service ids by the search framework.

Parameters

RArray< TUid > & aServiceIdArray

LaunchApplicationL(const CSearchDocumentId &)

IMPORT_C void

LaunchApplicationL

(

const CSearchDocumentId &

aResultId

)

Launches a viewer/editor application for the given document id.

Parameters

const CSearchDocumentId & aResultId

- The id of the given document to be launched.

NewL()

IMPORT_C CSearchClientSession *

NewL

(

)

[static]

Symbian OS 2 phased constructor.

SearchL(const CSearchQuery &, MSearchQueryObserver &, const TSearchThreshold &)

IMPORT_C void	SearchL	(	const CSearchQuery &	aQuery,
			MSearchQueryObserver &	aObserver,
			const TSearchThreshold &	aThreshold
		)

Starts the search process. This call is asynchronous and progress is notified through the observer.

Parameters

const CSearchQuery & aQuery	- The search query.
MSearchQueryObserver & aObserver	- The search observer.
const TSearchThreshold & aThreshold	- The threshold of the search (Example: maxResults, maxSearchInterval etc).

Member Data Documentation

CSearchClientSessionImp * iSessionImp

CSearchClientSessionImp *

iSessionImp

[private]

Pointer to the session imp Own