Class AdHocCommandData
java.lang.Object
org.jivesoftware.smack.packet.Stanza
org.jivesoftware.smack.packet.IQ
org.jivesoftware.smackx.commands.packet.AdHocCommandData
- All Implemented Interfaces:
Element
,IqView
,NamedElement
,StanzaView
,TopLevelStreamElement
,XmlElement
,XmlLangElement
,AdHocCommandDataView
Represents the state and the request of the execution of an adhoc command.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic enum
static enum
static class
static enum
The status of the stage in the adhoc command.Nested classes/interfaces inherited from class org.jivesoftware.smack.packet.IQ
IQ.IQChildElementXmlStringBuilder, IQ.ResponseType, IQ.Type
-
Field Summary
FieldsFields 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 -
Method Summary
Modifier and TypeMethodDescriptionstatic AdHocCommandDataBuilder
static AdHocCommandDataBuilder
static AdHocCommandDataBuilder
builder
(String node, XMPPConnection connection) Returns the action to execute.getForm()
Returns the form of the command.protected IQ.IQChildElementXmlStringBuilder
This method must be overwritten by IQ subclasses to create their child content.getName()
Returns the human name of the command.getNode()
Returns the identifier of the command.getNotes()
Returns the list of notes that the command has.Returns the status of the execution.Methods inherited from class org.jivesoftware.smack.packet.IQ
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, getExtensionElement, getExtensions, getExtensions, getExtensions, getExtensions, getExtensionsMap, getFrom, getLanguage, getNamespace, getStanzaId, getTo, hasExtension, hasExtension, hasStanzaIdSet, logCommonAttributes, overrideExtension, removeExtension, setError, setFrom, setNewStanzaId, 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.smackx.commands.packet.AdHocCommandDataView
isCompleted, isExecuting
Methods inherited from interface org.jivesoftware.smack.packet.IqView
getType, 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 Details
-
ELEMENT
- See Also:
-
NAMESPACE
- See Also:
-
-
Constructor Details
-
AdHocCommandData
-
-
Method Details
-
getNode
Description copied from interface:AdHocCommandDataView
Returns the identifier of the command.- Specified by:
getNode
in interfaceAdHocCommandDataView
- Returns:
- the node.
-
getName
Description copied from interface:AdHocCommandDataView
Returns the human name of the command.- Specified by:
getName
in interfaceAdHocCommandDataView
- Returns:
- the name of the command.
-
getSessionId
- Specified by:
getSessionId
in interfaceAdHocCommandDataView
-
getNotes
Description copied from interface:AdHocCommandDataView
Returns the list of notes that the command has.- Specified by:
getNotes
in interfaceAdHocCommandDataView
- Returns:
- the notes.
-
getForm
Description copied from interface:AdHocCommandDataView
Returns the form of the command.- Specified by:
getForm
in interfaceAdHocCommandDataView
- Returns:
- the data form associated with the command.
-
getAction
Description copied from interface:AdHocCommandDataView
Returns the action to execute. The action is set only on a request.- Specified by:
getAction
in interfaceAdHocCommandDataView
- Returns:
- the action to execute.
-
getStatus
Description copied from interface:AdHocCommandDataView
Returns the status of the execution.- Specified by:
getStatus
in interfaceAdHocCommandDataView
- Returns:
- the status.
-
getActions
- Specified by:
getActions
in interfaceAdHocCommandDataView
-
getExecuteAction
- Specified by:
getExecuteAction
in interfaceAdHocCommandDataView
-
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.
-
builder
-
builder
-
builder
-