#include <search.h>
Inherits IqHandler.
Inheritance diagram for Search:
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 (Stanza *stanza) |
virtual bool | handleIqID (Stanza *stanza, int context) |
To perform a search in a directory (e.g., a User Directory):
Definition at line 47 of file search.h.
Search | ( | ClientBase * | parent | ) |
Creates a new Search object.
parent | The ClientBase to use. |
Definition at line 23 of file search.cpp.
~Search | ( | ) |
Virtual Destructor.
Definition at line 28 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 32 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. | |
sh | The SearchHandler to notify about the results. |
Definition at line 51 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 (set) fields in the values parameter. | |
values | Contains the phrases to search for. | |
sh | The SearchHandler to notify about the results. |
Definition at line 71 of file search.cpp.
virtual bool handleIq | ( | Stanza * | stanza | ) | [inline, virtual] |
Reimplement this function if you want to be notified about incoming IQs.
stanza | The complete Stanza. |
Implements IqHandler.
bool handleIqID | ( | Stanza * | stanza, | |
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.
stanza | The complete Stanza. | |
context | A value to restore context, stored with ClientBase::trackID(). |
Implements IqHandler.
Definition at line 99 of file search.cpp.