public final class Search
extends java.lang.Object
The implementation of the <query/>
element in the jabber:iq:search
namespace.
This class is immutable.
Modifier and Type | Class and Description |
---|---|
static class |
Search.Item
The implementation of a search result item.
|
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
NAMESPACE
jabber:iq:search
|
Constructor and Description |
---|
Search()
Creates an empty search request.
|
Search(java.lang.String first,
java.lang.String last,
java.lang.String nick,
java.lang.String email)
Creates a search request, consisting of multiple search parameters.
|
Search(java.lang.String first,
java.lang.String last,
java.lang.String nick,
java.lang.String email,
ResultSetManagement resultSet,
java.lang.String instructions,
DataForm dataForm)
Creates a search request, consisting of multiple search parameters.
|
Modifier and Type | Method and Description |
---|---|
DataForm |
getAdditionalInformation()
Gets additional information for the search, e.g. for gender.
|
java.lang.String |
getEmail()
Gets the email address.
|
java.lang.String |
getFirst()
Gets the first name.
|
java.lang.String |
getInstructions()
Gets the search instructions.
|
java.util.List<Search.Item> |
getItems()
Gets the items of a search result.
|
java.lang.String |
getLast()
Gets the last name.
|
java.lang.String |
getNick()
Gets the nick name.
|
ResultSetManagement |
getResultSet()
Gets the result set information.
|
public static final java.lang.String NAMESPACE
jabber:iq:search
public Search()
Creates an empty search request.
public Search(java.lang.String first, java.lang.String last, java.lang.String nick, java.lang.String email)
Creates a search request, consisting of multiple search parameters.
first
- The first name.last
- The last name.nick
- The nick name.email
- The email.public Search(java.lang.String first, java.lang.String last, java.lang.String nick, java.lang.String email, ResultSetManagement resultSet, java.lang.String instructions, DataForm dataForm)
Creates a search request, consisting of multiple search parameters.
first
- The first name.last
- The last name.nick
- The nick name.email
- The email.resultSet
- The result set information.instructions
- The instructions.dataForm
- The data form.public final java.lang.String getInstructions()
Gets the search instructions.
public final java.lang.String getFirst()
Gets the first name.
public final java.lang.String getLast()
Gets the last name.
public final java.lang.String getNick()
Gets the nick name.
public final java.lang.String getEmail()
Gets the email address.
public final java.util.List<Search.Item> getItems()
Gets the items of a search result.
public final DataForm getAdditionalInformation()
Gets additional information for the search, e.g. for gender.
The fields defined in the ‘jabber:iq:search’ namespace are strictly limited to those specified in the schema. If a host needs to gather additional information, Data Forms SHOULD be used; a host MUST NOT add new fields to the ‘jabber:iq:search’ namespace. Support for extensibility via Data Forms is RECOMMENDED, but is not required for compliance with this document.
public final ResultSetManagement getResultSet()
Gets the result set information.
Copyright © 2014–2019 XMPP.rocks. All rights reserved.