gloox
1.0.28
|
#include <search.h>
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) |
Public Member Functions inherited from IqHandler | |
virtual | ~IqHandler () |
An implementation of XEP-0055 (Jabber Search)
To perform a search in a directory (e.g., a User Directory):
Search | ( | ClientBase * | parent | ) |
Creates a new Search object.
parent | The ClientBase to use. |
Definition at line 112 of file search.cpp.
~Search | ( | ) |
Virtual Destructor.
Definition at line 119 of file search.cpp.
void fetchSearchFields | ( | const JID & | directory, |
SearchHandler * | sh | ||
) |
Use this function to check which fields the directory supports.
directory | The (user) directory to fetch the available/searchable fields from. |
sh | The SearchHandler to notify about the results. |
Definition at line 128 of file search.cpp.
|
inlinevirtual |
Reimplement this function if you want to be notified about incoming IQs.
iq | The complete IQ stanza. |
Implements IqHandler.
|
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 empty positive reply, i.e. <iq type='result' id='reg'/> where a namespace filter wouldn't work.
iq | The complete IQ stanza. |
context | A value to restore context, stored with ClientBase::trackID(). |
Implements IqHandler.
Definition at line 167 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.
directory | The (user) directory to search. |
form | The DataForm contains the phrases the user wishes to search for. Search will delete the form eventually. |
sh | The SearchHandler to notify about the results. |
Definition at line 140 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.
directory | The (user) directory to search. |
fields | Bit-wise ORed FieldEnum values describing the valid (i.e., set) fields in the values parameter. |
values | Contains the phrases to search for. |
sh | The SearchHandler to notify about the results. |
Definition at line 153 of file search.cpp.