Package org.jivesoftware.smackx.muc.packet

Class MUCAdmin

java.lang.Object
org.jivesoftware.smack.packet.Stanza
org.jivesoftware.smack.packet.IQ
org.jivesoftware.smackx.muc.packet.MUCAdmin
All Implemented Interfaces:
Element, IqView, NamedElement, StanzaView, TopLevelStreamElement, XmlElement, XmlLangElement
public class MUCAdmin extends IQ
IQ stanza that serves for kicking users, granting and revoking voice, banning users, modifying the ban list, granting and revoking membership and granting and revoking moderator privileges. All these operations are scoped by the 'http://jabber.org/protocol/muc#admin' namespace.

  • Field Details

  • Constructor Details

  • Method Details

    • getItems

      public List<MUCItem> getItems()
      Returns a List of item children that holds information about roles, affiliation, jids and nicks.
      Returns:
      a List of item children that holds information about roles, affiliation, jids and nicks.

    • addItem

      public void addItem(MUCItem item)
      Adds an item child that holds information about roles, affiliation, jids and nicks.
      Parameters:
      item - the item child that holds information about roles, affiliation, jids and nicks.

    • 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.