SearchHandler Class Reference

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

#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, 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, Stanza *stanza)=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 62 of file searchhandler.h.

---

Constructor & Destructor Documentation

virtual ~SearchHandler (   )  [inline, virtual]

Virtual Destructor. Definition at line 68 of file searchhandler.h.

---

Member Function Documentation

virtual void handleSearchError (  const JID &  directory, Stanza *  stanza )  [pure virtual]

This function is called if a error occured as a result to a search or search field request. Parameters: directory  The queried/searched directory. stanza  The full error stanza.

virtual void handleSearchFields (  const JID &  directory, 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() . Note: The SearchHandler is responsible for deleting the DataForm. Parameters: directory  The directory that was queried. form  A DataForm describing the valid searchable fields.

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: directory  The directory that was queried. fields  Bit-wise ORed SearchFieldEnum values. instructions  Plain-text instructions for the end user.

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. Note: The SearchHandler is responsible for deleting the DataForm. Parameters: directory  The searched directory. form  A DataForm containing the search results.

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: directory  The searched directory. resultList  A list of SearchFieldStructs. May be empty.

---

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

• searchhandler.h

---