Package org.jivesoftware.smackx.muc.packet

Class MUCUser

java.lang.Object
org.jivesoftware.smackx.muc.packet.MUCUser
All Implemented Interfaces:
org.jivesoftware.smack.packet.Element, org.jivesoftware.smack.packet.ExtensionElement, org.jivesoftware.smack.packet.NamedElement, org.jivesoftware.smack.packet.XmlElement, org.jivesoftware.smack.packet.XmlLangElement
public class MUCUser extends Object implements org.jivesoftware.smack.packet.ExtensionElement
Represents extended presence information about roles, affiliations, full JIDs, or status codes scoped by the 'http://jabber.org/protocol/muc#user' namespace.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static class 
    MUCUser.Decline
    Represents a rejection to an invitation from another user to a room.
    static class 
    MUCUser.Invite
    Represents an invitation for another user to a room.
    static final class 
    MUCUser.Status
    Status code assists in presenting notification messages.

  • Field Summary

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

  • Constructor Summary

    Constructors
    Constructor
    Description
    MUCUser()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addStatusCode(MUCUser.Status status)
    Add a status code which hold a code that assists in presenting notification messages.
    void
    addStatusCodes(Set<MUCUser.Status> statusCodes)
    Add the status codes which holds the codes that assists in presenting notification messages.
    static MUCUser
    from(org.jivesoftware.smack.packet.Stanza packet)
    Retrieve the MUCUser PacketExtension from packet, if any.
    MUCUser.Decline
    getDecline()
    Returns the rejection to an invitation from another user to a room.
    Destroy
    getDestroy()
    Returns the notification that the room has been destroyed.
    String
    getElementName()
     
    static MUCUser
    getFrom(org.jivesoftware.smack.packet.Stanza packet)
    Deprecated.
    use from(Stanza) instead
    MUCUser.Invite
    getInvite()
    Returns the invitation for another user to a room.
    MUCItem
    getItem()
    Returns the item child that holds information about roles, affiliation, jids and nicks.
    String
    getNamespace()
     
    String
    getPassword()
    Returns the password to use to enter Password-Protected Room.
    Set<MUCUser.Status>
    getStatus()
    Returns a set of status which holds the status code that assist in presenting notification messages.
    boolean
    hasStatus()
    Returns true if this MUCUser instance has also MUCUser.Status information.
    void
    setDecline(MUCUser.Decline decline)
    Sets the rejection to an invitation from another user to a room.
    void
    setDestroy(Destroy destroy)
    Sets the notification that the room has been destroyed.
    void
    setInvite(MUCUser.Invite invite)
    Sets the invitation for another user to a room.
    void
    setItem(MUCItem item)
    Sets the item child that holds information about roles, affiliation, jids and nicks.
    void
    setPassword(String string)
    Sets the password to use to enter Password-Protected Room.
    org.jivesoftware.smack.util.XmlStringBuilder
    toXML(org.jivesoftware.smack.packet.XmlEnvironment enclosingNamespace)
     

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface org.jivesoftware.smack.packet.Element

    toXML, toXML

    Methods inherited from interface org.jivesoftware.smack.packet.XmlElement

    getLanguage, getQName

  • Field Details

  • Constructor Details

    • MUCUser

      public MUCUser()

  • Method Details

    • getElementName

      public String getElementName()
      Specified by:
      getElementName in interface org.jivesoftware.smack.packet.NamedElement

    • getNamespace

      public String getNamespace()
      Specified by:
      getNamespace in interface org.jivesoftware.smack.packet.XmlElement

    • toXML

      public org.jivesoftware.smack.util.XmlStringBuilder toXML(org.jivesoftware.smack.packet.XmlEnvironment enclosingNamespace)
      Specified by:
      toXML in interface org.jivesoftware.smack.packet.Element

    • getInvite

      public MUCUser.Invite getInvite()
      Returns the invitation for another user to a room. The sender of the invitation must be an occupant of the room. The invitation will be sent to the room which in turn will forward the invitation to the invitee.
      Returns:
      an invitation for another user to a room.

    • getDecline

      public MUCUser.Decline getDecline()
      Returns the rejection to an invitation from another user to a room. The rejection will be sent to the room which in turn will forward the refusal to the inviting user.
      Returns:
      a rejection to an invitation from another user to a room.

    • getItem

      public MUCItem getItem()
      Returns the item child that holds information about roles, affiliation, jids and nicks.
      Returns:
      an item child that holds information about roles, affiliation, jids and nicks.

    • getPassword

      public String getPassword()
      Returns the password to use to enter Password-Protected Room. A Password-Protected Room is a room that a user cannot enter without first providing the correct password.
      Returns:
      the password to use to enter Password-Protected Room.

    • getStatus

      public Set<MUCUser.Status> getStatus()
      Returns a set of status which holds the status code that assist in presenting notification messages.
      Returns:
      the set of status which holds the status code that assist in presenting notification messages.

    • hasStatus

      public boolean hasStatus()
      Returns true if this MUCUser instance has also MUCUser.Status information.

      If true is returned, then getStatus() will return a non-empty set.

      Returns:
      true if this MUCUser has status information.
      Since:
      4.1

    • getDestroy

      public Destroy getDestroy()
      Returns the notification that the room has been destroyed. After a room has been destroyed, the room occupants will receive a Presence stanza of type 'unavailable' with the reason for the room destruction if provided by the room owner.
      Returns:
      a notification that the room has been destroyed.

    • setInvite

      public void setInvite(MUCUser.Invite invite)
      Sets the invitation for another user to a room. The sender of the invitation must be an occupant of the room. The invitation will be sent to the room which in turn will forward the invitation to the invitee.
      Parameters:
      invite - the invitation for another user to a room.

    • setDecline

      public void setDecline(MUCUser.Decline decline)
      Sets the rejection to an invitation from another user to a room. The rejection will be sent to the room which in turn will forward the refusal to the inviting user.
      Parameters:
      decline - the rejection to an invitation from another user to a room.

    • setItem

      public void setItem(MUCItem item)
      Sets the 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.

    • setPassword

      public void setPassword(String string)
      Sets the password to use to enter Password-Protected Room. A Password-Protected Room is a room that a user cannot enter without first providing the correct password.
      Parameters:
      string - the password to use to enter Password-Protected Room.

    • addStatusCodes

      public void addStatusCodes(Set<MUCUser.Status> statusCodes)
      Add the status codes which holds the codes that assists in presenting notification messages.
      Parameters:
      statusCodes - the status codes which hold the codes that assists in presenting notification messages.

    • addStatusCode

      public void addStatusCode(MUCUser.Status status)
      Add a status code which hold a code that assists in presenting notification messages.
      Parameters:
      status - the status code which olds a code that assists in presenting notification messages.

    • setDestroy

      public void setDestroy(Destroy destroy)
      Sets the notification that the room has been destroyed. After a room has been destroyed, the room occupants will receive a Presence stanza of type 'unavailable' with the reason for the room destruction if provided by the room owner.
      Parameters:
      destroy - the notification that the room has been destroyed.

    • getFrom

      @Deprecated public static MUCUser getFrom(org.jivesoftware.smack.packet.Stanza packet)
      Deprecated.
      use from(Stanza) instead
      Retrieve the MUCUser PacketExtension from packet, if any.
      Parameters:
      packet - TODO javadoc me please
      Returns:
      the MUCUser PacketExtension or null

    • from

      public static MUCUser from(org.jivesoftware.smack.packet.Stanza packet)
      Retrieve the MUCUser PacketExtension from packet, if any.
      Parameters:
      packet - TODO javadoc me please
      Returns:
      the MUCUser PacketExtension or null