Package org.jivesoftware.smackx.commands.packet

Class AdHocCommandData

    • Method Detail

      • 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 by IQ.IQChildElementXmlStringBuilder after eventual existing ExtensionElements 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>
        the body of the 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')
        If your IQ only contains attributes and no child elements, i.e. it can be represented as empty element, then you can mark it as such. 
         xml.attribute("myAttribute", "myAttributeValue");
 xml.setEmptyElement();
        If your IQ does not contain any attributes or child elements (besides ExtensionElements), consider sub-classing SimpleIQ instead.
        Specified by:
        getIQChildElementBuilder in class IQ
        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.

      • getId

        public Jid getId()
        Returns the JID of the command host.
        Returns:
        the JID of the command host.

      • getName

        public java.lang.String getName()
        Returns the human name of the command.
        Returns:
        the name of the command.

      • setName

        public void setName​(java.lang.String name)

      • getNode

        public java.lang.String getNode()
        Returns the identifier of the command.
        Returns:
        the node.

      • setNode

        public void setNode​(java.lang.String node)

      • getNotes

        public java.util.List<AdHocCommandNote> getNotes()
        Returns the list of notes that the command has.
        Returns:
        the notes.

      • getForm

        public DataForm getForm()
        Returns the form of the command.
        Returns:
        the data form associated with the command.

      • getAction

        public AdHocCommand.Action getAction()
        Returns the action to execute. The action is set only on a request.
        Returns:
        the action to execute.

      • setSessionID

        public void setSessionID​(java.lang.String sessionID)
        Set the 'sessionid' attribute of the command.

        This value can be null or empty for the first command, but MUST be set for subsequent commands. See also XEP-0050 ยง 3.3 Session Lifetime.

        Parameters:
        sessionID - TODO javadoc me please