gloox  1.0
Public Member Functions
SearchHandler Class Reference

#include <searchhandler.h>

List of all members.

Public Member Functions

virtual ~SearchHandler ()
virtual void handleSearchFields (const JID &directory, int fields, const std::string &instructions)=0
virtual void handleSearchFields (const JID &directory, const DataForm *form)=0
virtual void handleSearchResult (const JID &directory, const SearchResultList &resultList)=0
virtual void handleSearchResult (const JID &directory, const DataForm *form)=0
virtual void handleSearchError (const JID &directory, const Error *error)=0

Detailed Description

A virtual interface that enables objects to receive Jabber Search (XEP-0055) results.

A class implementing this interface can receive the result of a Jabber Search.

Author:
Jakob Schroeter <js@camaya.net>
Since:
0.8.5

Definition at line 144 of file searchhandler.h.


Constructor & Destructor Documentation

virtual ~SearchHandler ( ) [inline, virtual]

Virtual Destructor.

Definition at line 150 of file searchhandler.h.


Member Function Documentation

virtual void handleSearchError ( const JID directory,
const Error error 
) [pure virtual]

This function is called if a error occured as a result to a search or search field request.

Parameters:
directoryThe queried/searched directory.
errorThe error. May be 0.
virtual void handleSearchFields ( const JID directory,
int  fields,
const std::string &  instructions 
) [pure virtual]

This function is called to announce the searchable fields a directory supports. It is the result of a call to Search::fetchSearchFields() .

Parameters:
directoryThe directory that was queried.
fieldsBit-wise ORed SearchFieldEnum values.
instructionsPlain-text instructions for the end user.
virtual void handleSearchFields ( const JID directory,
const DataForm form 
) [pure virtual]

This function is called to announce the searchable fields a directory supports. It is the result of a call to Search::fetchSearchFields() .

Parameters:
directoryThe directory that was queried.
formA DataForm describing the valid searchable fields. Do not delete the form.
virtual void handleSearchResult ( const JID directory,
const SearchResultList resultList 
) [pure virtual]

This function is called to let the SearchHandler know about the results of the search.

Parameters:
directoryThe searched directory.
resultListA list of SearchFieldStructs. May be empty.
virtual void handleSearchResult ( const JID directory,
const DataForm form 
) [pure virtual]

This function is called to let the SearchHandler know about the result of the search.

Parameters:
directoryThe searched directory.
formA DataForm containing the search results. Do not delete the form.

The documentation for this class was generated from the following file: