gloox 1.0
Public Member Functions

Search Class Reference

An implementation of XEP-0055 (Jabber Search) More...

#include <search.h>

Inheritance diagram for Search:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 Search (ClientBase *parent)
 ~Search ()
void fetchSearchFields (const JID &directory, SearchHandler *sh)
void search (const JID &directory, DataForm *form, SearchHandler *sh)
void search (const JID &directory, int fields, const SearchFieldStruct &values, SearchHandler *sh)
virtual bool handleIq (const IQ &iq)
virtual void handleIqID (const IQ &iq, int context)

Detailed Description

An implementation of XEP-0055 (Jabber Search)

To perform a search in a directory (e.g., a User Directory):

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

Definition at line 49 of file search.h.


Constructor & Destructor Documentation

Search ( ClientBase parent)

Creates a new Search object.

Parameters:
parentThe ClientBase to use.

Definition at line 113 of file search.cpp.

~Search ( )

Virtual Destructor.

Definition at line 120 of file search.cpp.


Member Function Documentation

void fetchSearchFields ( const JID directory,
SearchHandler sh 
)

Use this function to check which fields the directory supports.

Parameters:
directoryThe (user) directory to fetch the available/searchable fields from.
shThe SearchHandler to notify about the results.

Definition at line 129 of file search.cpp.

virtual bool handleIq ( const IQ iq) [inline, virtual]

Reimplement this function if you want to be notified about incoming IQs.

Parameters:
iqThe complete IQ stanza.
Returns:
Indicates whether a request of type 'get' or 'set' has been handled. This includes the obligatory 'result' answer. If you return false, a 'error' will be sent.
Since:
1.0

Implements IqHandler.

Definition at line 93 of file search.h.

void handleIqID ( const IQ iq,
int  context 
) [virtual]

Reimplement this function if you want to be notified about incoming IQs with a specific value of the id attribute. You have to enable tracking of those IDs using Client::trackID(). This is usually useful for IDs that generate a positive reply, i.e. <iq type='result' id='reg'/> where a namespace filter wouldn't work.

Parameters:
iqThe complete IQ stanza.
contextA value to restore context, stored with ClientBase::trackID().
Note:
Only IQ stanzas of type 'result' or 'error' can arrive here.
Since:
1.0

Implements IqHandler.

Definition at line 168 of file search.cpp.

void search ( const JID directory,
int  fields,
const SearchFieldStruct values,
SearchHandler sh 
)

Initiates a search on the given directory, with the given phrases. The given SearchHandler is notified about the results.

Parameters:
directoryThe (user) directory to search.
fieldsBit-wise ORed FieldEnum values describing the valid (i.e., set) fields in the values parameter.
valuesContains the phrases to search for.
shThe SearchHandler to notify about the results.

Definition at line 154 of file search.cpp.

void search ( const JID directory,
DataForm form,
SearchHandler sh 
)

Initiates a search on the given directory, with the given data form. The given SearchHandler is notified about the results.

Parameters:
directoryThe (user) directory to search.
formThe DataForm contains the phrases the user wishes to search for. Search will delete the form eventually.
shThe SearchHandler to notify about the results.

Definition at line 141 of file search.cpp.


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