Class Registration
- java.lang.Object
-
- org.jivesoftware.smack.packet.Stanza
-
- org.jivesoftware.smack.packet.IQ
-
- org.jivesoftware.smackx.iqregister.packet.Registration
-
- All Implemented Interfaces:
org.jivesoftware.smack.packet.Element
,org.jivesoftware.smack.packet.FullyQualifiedElement
,org.jivesoftware.smack.packet.IqView
,org.jivesoftware.smack.packet.NamedElement
,org.jivesoftware.smack.packet.StanzaView
,org.jivesoftware.smack.packet.TopLevelStreamElement
,org.jivesoftware.smack.packet.XmlLangElement
public class Registration extends org.jivesoftware.smack.packet.IQ
Represents registration packets. An empty GET query will cause the server to return information about it's registration support. SET queries can be used to create accounts or update existing account information. XMPP servers may require a number of attributes to be set when creating a new account. The standard account attributes are as follows:- name -- the user's name.
- first -- the user's first name.
- last -- the user's last name.
- email -- the user's email address.
- city -- the user's city.
- state -- the user's state.
- zip -- the user's ZIP code.
- phone -- the user's phone number.
- url -- the user's website.
- date -- the date the registration took place.
- misc -- other miscellaneous information to associate with the account.
- text -- textual information to associate with the account.
- remove -- empty flag to remove account.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Registration.Feature
-
Constructor Summary
Constructors Constructor Description Registration()
Registration(java.lang.String instructions, java.util.Map<java.lang.String,java.lang.String> attributes)
Registration(java.util.Map<java.lang.String,java.lang.String> attributes)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description java.util.Map<java.lang.String,java.lang.String>
getAttributes()
Returns the map of String key/value pairs of account attributes.java.lang.String
getInstructions()
Returns the registration instructions, ornull
if no instructions have been set.protected org.jivesoftware.smack.packet.IQ.IQChildElementXmlStringBuilder
getIQChildElementBuilder(org.jivesoftware.smack.packet.IQ.IQChildElementXmlStringBuilder xml)
-
Methods inherited from class org.jivesoftware.smack.packet.IQ
createErrorResponse, createErrorResponse, createErrorResponse, createResultIQ, getChildElementName, getChildElementNamespace, getChildElementQName, getChildElementXML, getElementName, getType, isRequestIQ, isResponseIQ, setType, toString, toXML
-
Methods inherited from class org.jivesoftware.smack.packet.Stanza
addCommonAttributes, addExtension, addExtensions, appendErrorIfExists, getDefaultLanguage, getError, getExtension, getExtension, getExtension, getExtensionElement, getExtensions, getExtensions, getExtensions, getExtensions, getExtensionsMap, getFrom, getLanguage, getNamespace, getStanzaId, getTo, hasExtension, hasExtension, hasStanzaIdSet, logCommonAttributes, overrideExtension, removeExtension, removeExtension, setError, setError, setFrom, setLanguage, setNewStanzaId, setStanzaId, setStanzaId, setTo, throwIfNoStanzaId
-
-
-
-
Field Detail
-
ELEMENT
public static final java.lang.String ELEMENT
- See Also:
- Constant Field Values
-
NAMESPACE
public static final java.lang.String NAMESPACE
- See Also:
- Constant Field Values
-
-
Method Detail
-
getInstructions
public java.lang.String getInstructions()
Returns the registration instructions, ornull
if no instructions have been set. If present, instructions should be displayed to the end-user that will complete the registration process.- Returns:
- the registration instructions, or
null
if there are none.
-
getAttributes
public java.util.Map<java.lang.String,java.lang.String> getAttributes()
Returns the map of String key/value pairs of account attributes.- Returns:
- the account attributes.
-
getIQChildElementBuilder
protected org.jivesoftware.smack.packet.IQ.IQChildElementXmlStringBuilder getIQChildElementBuilder(org.jivesoftware.smack.packet.IQ.IQChildElementXmlStringBuilder xml)
- Specified by:
getIQChildElementBuilder
in classorg.jivesoftware.smack.packet.IQ
-
-