Package org.jivesoftware.smackx.commands.packet

Class AdHocCommandData

java.lang.Object
org.jivesoftware.smack.packet.Stanza
org.jivesoftware.smack.packet.IQ
org.jivesoftware.smackx.commands.packet.AdHocCommandData
All Implemented Interfaces:
org.jivesoftware.smack.packet.Element, org.jivesoftware.smack.packet.IqView, org.jivesoftware.smack.packet.NamedElement, org.jivesoftware.smack.packet.StanzaView, org.jivesoftware.smack.packet.TopLevelStreamElement, org.jivesoftware.smack.packet.XmlElement, org.jivesoftware.smack.packet.XmlLangElement, AdHocCommandDataView
public class AdHocCommandData extends org.jivesoftware.smack.packet.IQ implements AdHocCommandDataView
Represents the state and the request of the execution of an adhoc command.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    AdHocCommandData.Action
     
    static enum 
    AdHocCommandData.AllowedAction
     
    static class 
    AdHocCommandData.SpecificError
     
    static enum 
    AdHocCommandData.Status
    The status of the stage in the adhoc command.

    Nested classes/interfaces inherited from class org.jivesoftware.smack.packet.IQ

    org.jivesoftware.smack.packet.IQ.IQChildElementXmlStringBuilder, org.jivesoftware.smack.packet.IQ.ResponseType, org.jivesoftware.smack.packet.IQ.Type

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    ELEMENT
     
    static final String
    NAMESPACE
     

    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
    AdHocCommandData(AdHocCommandDataBuilder builder)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static AdHocCommandDataBuilder
    builder(String node, String stanzaId)
     
    static AdHocCommandDataBuilder
    builder(String node, org.jivesoftware.smack.packet.IqData iqCommon)
     
    static AdHocCommandDataBuilder
    builder(String node, org.jivesoftware.smack.XMPPConnection connection)
     
    AdHocCommandData.Action
    getAction()
    Returns the action to execute.
    Set<AdHocCommandData.AllowedAction>
    getActions()
     
    AdHocCommandData.AllowedAction
    getExecuteAction()
     
    DataForm
    getForm()
    Returns the form of the command.
    protected org.jivesoftware.smack.packet.IQ.IQChildElementXmlStringBuilder
    getIQChildElementBuilder(org.jivesoftware.smack.packet.IQ.IQChildElementXmlStringBuilder xml)
     
    String
    getName()
    Returns the human name of the command.
    String
    getNode()
    Returns the identifier of the command.
    List<AdHocCommandNote>
    getNotes()
    Returns the list of notes that the command has.
    String
    getSessionId()
     
    AdHocCommandData.Status
    getStatus()
    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.Element

    toXML, toXML

    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