Class MamQueryIQ
- java.lang.Object
-
- org.jivesoftware.smack.packet.Stanza
-
- org.jivesoftware.smack.packet.IQ
-
- org.jivesoftware.smackx.mam.element.MamQueryIQ
-
- All Implemented Interfaces:
Element
,IqView
,NamedElement
,StanzaView
,TopLevelStreamElement
,XmlElement
,XmlLangElement
public class MamQueryIQ extends IQ
MAM Query IQ class.- See Also:
- XEP-0313: Message Archive Management
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.jivesoftware.smack.packet.IQ
IQ.IQChildElementXmlStringBuilder, IQ.ResponseType, IQ.Type
-
-
Field Summary
Fields Modifier and Type Field Description static String
ELEMENT
the MAM query IQ element.-
Fields inherited from class org.jivesoftware.smack.packet.IQ
IQ_ELEMENT, QUERY_ELEMENT
-
Fields inherited from class org.jivesoftware.smack.packet.Stanza
DEFAULT_LANGUAGE, ITEM, language, TEXT
-
-
Constructor Summary
Constructors Constructor Description MamQueryIQ(MamVersion version, String queryId)
MAM query IQ constructor.MamQueryIQ(MamVersion version, String queryId, String node, DataForm dataForm)
MAM query IQ constructor.MamQueryIQ(MamVersion version, String queryId, DataForm form)
MAM query IQ constructor.MamQueryIQ(MamVersion version, DataForm form)
MAM query IQ constructor.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description DataForm
getDataForm()
Get the data form.protected IQ.IQChildElementXmlStringBuilder
getIQChildElementBuilder(IQ.IQChildElementXmlStringBuilder xml)
This method must be overwritten by IQ subclasses to create their child content.String
getNode()
Get the Node name.String
getQueryId()
Get query id.-
Methods inherited from class org.jivesoftware.smack.packet.IQ
createErrorResponse, createErrorResponse, createErrorResponse, createResultIQ, getChildElementName, getChildElementNamespace, getChildElementQName, getChildElementXML, getElementName, getType, 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
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.jivesoftware.smack.packet.IqView
isRequestIQ, isResponseIQ
-
Methods inherited from interface org.jivesoftware.smack.packet.StanzaView
getError, getExtension, getExtension, getExtensions, getExtensions, getExtensions, getFrom, getStanzaId, getTo, hasExtension, hasExtension, hasExtension
-
Methods inherited from interface org.jivesoftware.smack.packet.XmlElement
getQName
-
-
-
-
Field Detail
-
ELEMENT
public static final String ELEMENT
the MAM query IQ element.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
MamQueryIQ
public MamQueryIQ(MamVersion version, String queryId)
MAM query IQ constructor.- Parameters:
version
- TODO javadoc me pleasequeryId
- TODO javadoc me please
-
MamQueryIQ
public MamQueryIQ(MamVersion version, DataForm form)
MAM query IQ constructor.- Parameters:
version
- TODO javadoc me pleaseform
- TODO javadoc me please
-
MamQueryIQ
public MamQueryIQ(MamVersion version, String queryId, DataForm form)
MAM query IQ constructor.- Parameters:
version
- TODO javadoc me pleasequeryId
- TODO javadoc me pleaseform
- TODO javadoc me please
-
MamQueryIQ
public MamQueryIQ(MamVersion version, String queryId, String node, DataForm dataForm)
MAM query IQ constructor.- Parameters:
version
- TODO javadoc me pleasequeryId
- TODO javadoc me pleasenode
- TODO javadoc me pleasedataForm
- TODO javadoc me please
-
-
Method Detail
-
getQueryId
public String getQueryId()
Get query id.- Returns:
- the query id
-
getDataForm
public DataForm getDataForm()
Get the data form.- Returns:
- the data form
-
getIQChildElementBuilder
protected IQ.IQChildElementXmlStringBuilder getIQChildElementBuilder(IQ.IQChildElementXmlStringBuilder xml)
Description copied from class:IQ
This method must be overwritten by IQ subclasses to create their child content. It is important you don't use the builder to add the final end tag. This will be done automatically byIQ.IQChildElementXmlStringBuilder
after eventual existingExtensionElement
s have been added.For example to create an IQ with a extra attribute and an additional child element
<iq to='foo@example.org' id='123'> <bar xmlns='example:bar' extraAttribute='blaz'> <extraElement>elementText</extraElement> </bar> </iq>
getIQChildElementBuilder
looks like// The builder 'xml' will already have the child element and the 'xmlns' attribute added // So the current builder state is "<bar xmlns='example:bar'" xml.attribute("extraAttribute", "blaz"); xml.rightAngleBracket(); xml.element("extraElement", "elementText"); // Do not close the 'bar' attribute by calling xml.closeElement('bar')
xml.attribute("myAttribute", "myAttributeValue"); xml.setEmptyElement();
If your IQ does not contain any attributes or child elements (besidesExtensionElement
s), consider sub-classingSimpleIQ
instead.- Specified by:
getIQChildElementBuilder
in classIQ
- Parameters:
xml
- a pre-created builder which already has the child element and the 'xmlns' attribute set.- Returns:
- the build to create the IQ child content.
-
-