| 
 | Smack | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.jivesoftware.smack.packet.Packet
org.jivesoftware.smack.packet.IQ
org.jivesoftware.smackx.search.UserSearch
public class UserSearch
Implements the protocol currently used to search information repositories on the Jabber network. To date, the jabber:iq:search protocol has been used mainly to search for people who have registered with user directories (e.g., the "Jabber User Directory" hosted at users.jabber.org). However, the jabber:iq:search protocol is not limited to user directories, and could be used to search other Jabber information repositories (such as chatroom directories) or even to provide a Jabber interface to conventional search engines.
The basic functionality is to query an information repository regarding the possible search fields, to send a search query, and to receive search results.
| Nested Class Summary | |
|---|---|
| static class | UserSearch.ProviderInternal Search service Provider. | 
| Nested classes/interfaces inherited from class org.jivesoftware.smack.packet.IQ | 
|---|
| IQ.Type | 
| Field Summary | 
|---|
| Fields inherited from class org.jivesoftware.smack.packet.Packet | 
|---|
| DEFAULT_LANGUAGE, ID_NOT_AVAILABLE | 
| Constructor Summary | |
|---|---|
| UserSearch()Creates a new instance of UserSearch. | |
| Method Summary | |
|---|---|
|  String | getChildElementXML()Returns the sub-element XML section of the IQ packet, or null if there isn't one. | 
|  Form | getSearchForm(Connection con,
              String searchService)Returns the form for all search fields supported by the search service. | 
|  ReportedData | sendSearchForm(Connection con,
               Form searchForm,
               String searchService)Sends the filled out answer form to be sent and queried by the search service. | 
|  ReportedData | sendSimpleSearchForm(Connection con,
                     Form searchForm,
                     String searchService)Sends the filled out answer form to be sent and queried by the search service. | 
| Methods inherited from class org.jivesoftware.smack.packet.IQ | 
|---|
| createErrorResponse, createResultIQ, getType, setType, toXML | 
| Methods inherited from class org.jivesoftware.smack.packet.Packet | 
|---|
| addExtension, deleteProperty, equals, getDefaultLanguage, getError, getExtension, getExtension, getExtensions, getExtensionsXML, getFrom, getPacketID, getProperty, getPropertyNames, getTo, getXmlns, hashCode, nextID, removeExtension, setDefaultXmlns, setError, setFrom, setPacketID, setProperty, setTo | 
| Methods inherited from class java.lang.Object | 
|---|
| clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait | 
| Constructor Detail | 
|---|
public UserSearch()
| Method Detail | 
|---|
public String getChildElementXML()
IQExtensions of this class must override this method.
getChildElementXML in class IQ
public Form getSearchForm(Connection con,
                          String searchService)
                   throws XMPPException
con - the current Connection.searchService - the search service to use. (ex. search.jivesoftware.com)
XMPPException - thrown if a server error has occurred.
public ReportedData sendSearchForm(Connection con,
                                   Form searchForm,
                                   String searchService)
                            throws XMPPException
con - the current Connection.searchForm - the Form to send for querying.searchService - the search service to use. (ex. search.jivesoftware.com)
XMPPException - thrown if a server error has occurred.
public ReportedData sendSimpleSearchForm(Connection con,
                                         Form searchForm,
                                         String searchService)
                                  throws XMPPException
con - the current Connection.searchForm - the Form to send for querying.searchService - the search service to use. (ex. search.jivesoftware.com)
XMPPException - thrown if a server error has occurred.| 
 | Smack | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||