Class RoomInformation


  • public final class RoomInformation
    extends Object
    Represents information about a chat room.

    This class wraps the service discovery information result, which usually consists of identities, features and extended forms into one class, so that a developer doesn't have to deal with the complex structure of the service discovery result.

    See Also:
    6.4 Querying for Room Information, ChatRoom.getRoomInformation()
    • Method Detail

      • getName

        public String getName()
        Gets the name of the room.
        Returns:
        The room name.
      • getMaxHistoryMessages

        public int getMaxHistoryMessages()
        Gets the maximum number of history messages returned by the room.
        Returns:
        The maximum number of history messages returned by the room.
      • getContacts

        public List<Jid> getContacts()
        Gets the contact addresses (normally, room owner or owners).
        Returns:
        The contact addresses.
      • getDescription

        public String getDescription()
        Gets a short description.
        Returns:
        The description.
      • getLanguage

        public Locale getLanguage()
        Gets the natural language for room discussions.
        Returns:
        The language.
      • getLdapGroup

        public String getLdapGroup()
        Gets an associated LDAP group that defines room membership; this should be an LDAP Distinguished Name according to an implementation-specific or deployment-specific definition of a group.
        Returns:
        The LDAP group.
      • getLogs

        public URL getLogs()
        Gets an URL for archived discussion logs.
        Returns:
        The URL.
      • getCurrentNumberOfOccupants

        public Integer getCurrentNumberOfOccupants()
        Gets the current number of occupants in the room.
        Returns:
        The number of occupants.
      • getSubject

        public String getSubject()
        Gets the current discussion topic.
        Returns:
        The topic.
      • isChangeSubjectAllowed

        public boolean isChangeSubjectAllowed()
        Indicates, whether the room subject can be modified by participants.
        Returns:
        Whether the room subject can be modified by participants.
      • isHidden

        public boolean isHidden()
        Hidden room.
        Returns:
        If the room is hidden.
      • isMembersOnly

        public boolean isMembersOnly()
        Members-only room.
        Returns:
        If the room is members-only.
      • isModerated

        public boolean isModerated()
        Moderated room.
        Returns:
        If the room is moderated.
      • isNonAnonymous

        public boolean isNonAnonymous()
        Non-anonymous room.
        Returns:
        If the room is non-anonymous.
      • isOpen

        public boolean isOpen()
        Open room.
        Returns:
        If the room is open.
      • isPasswordProtected

        public boolean isPasswordProtected()
        Password-protected room.
        Returns:
        If the room is password-protected.
      • isPersistent

        public boolean isPersistent()
        Persistent room.
        Returns:
        If the room is persistent.
      • isPublic

        public boolean isPublic()
        Public room.
        Returns:
        If the room is public.
      • isSemiAnonymous

        public boolean isSemiAnonymous()
        Semi-anonymous room.
        Returns:
        If the room is semi-anonymous.
      • isTemporary

        public boolean isTemporary()
        Temporary room.
        Returns:
        If the room is temporary.
      • isUnmoderated

        public boolean isUnmoderated()
        Unmoderated room.
        Returns:
        If the room is unmoderated.
      • isUnsecured

        public boolean isUnsecured()
        Unsecured room.
        Returns:
        If the room is unsecured.