Package org.jivesoftware.smackx.muc
Class RoomInfo
java.lang.Object
org.jivesoftware.smackx.muc.RoomInfo
Represents the room information that was discovered using Service Discovery. It's possible to
obtain information about a room before joining the room but only for rooms that are public (i.e.
rooms that may be discovered).
-
Method Summary
Modifier and TypeMethodDescriptionReturns Contact Addresses as JIDs, if such are reported.Returns the discovered description of the room.getForm()
Returns the form included in the extended disco info result ornull
if no such form was sent.getLang()
Returns the natural language of the room discussion, ornull
.Returns an associated LDAP group that defines room membership.Returns the URL where archived discussion logs can be found ornull
if there is no such URL.int
Returns the maximum number of history messages which are returned by the room or '-1' if this property is not reported by the room.getName()
Returns the room name.int
Returns the discovered number of occupants that are currently in the room.An associated pubsub node for this room ornull
.getRoom()
Returns the JID of the room whose information was discovered.Returns the discovered subject of the room.boolean
Returns true if the room has restricted the access so that only members may enter the room.boolean
Returns true if the room enabled only participants to speak.boolean
Returns true if presence packets will include the JID of every occupant.boolean
Returns true if users must provide a valid password in order to join the room.boolean
Returns true if the room will persist after the last occupant have left the room.Returns an Boolean instance with the value 'true' if the subject can be modified by the room participants, 'false' if not, ornull
if this information is reported by the room.
-
Method Details
-
getRoom
Returns the JID of the room whose information was discovered.- Returns:
- the JID of the room whose information was discovered.
-
getName
Returns the room name.The name returned here was provided as value of the name attribute of the returned identity within the disco#info result.
- Returns:
- the name of the room.
-
getDescription
Returns the discovered description of the room.The description returned by this method was provided as value of the form field of the extended disco info result. It may be
null
.- Returns:
- the discovered description of the room or null
-
getSubject
Returns the discovered subject of the room. The subject may be null if the room does not have a subject.- Returns:
- the discovered subject of the room or null
-
getOccupantsCount
Returns the discovered number of occupants that are currently in the room. If this information was not discovered (i.e. the server didn't send it) then a value of -1 will be returned.- Returns:
- the number of occupants that are currently in the room or -1 if that information was not provided by the server.
-
isMembersOnly
Returns true if the room has restricted the access so that only members may enter the room.- Returns:
- true if the room has restricted the access so that only members may enter the room.
-
isModerated
Returns true if the room enabled only participants to speak. Occupants with a role of visitor won't be able to speak in the room.- Returns:
- true if the room enabled only participants to speak.
-
isNonanonymous
Returns true if presence packets will include the JID of every occupant.- Returns:
- true if presence packets will include the JID of every occupant.
-
isPasswordProtected
Returns true if users must provide a valid password in order to join the room.- Returns:
- true if users must provide a valid password in order to join the room.
-
isPersistent
Returns true if the room will persist after the last occupant have left the room.- Returns:
- true if the room will persist after the last occupant have left the room.
-
getMaxHistoryFetch
Returns the maximum number of history messages which are returned by the room or '-1' if this property is not reported by the room.- Returns:
- the maximum number of history messages or '-1'
-
getContactJids
Returns Contact Addresses as JIDs, if such are reported.- Returns:
- a list of contact addresses for this room.
-
getLang
Returns the natural language of the room discussion, ornull
.- Returns:
- the language of the room discussion or
null
.
-
getLdapGroup
Returns an associated LDAP group that defines room membership. The value should be an LDAP Distinguished Name according to an implementation-specific or deployment-specific definition of a group.- Returns:
- an associated LDAP group or
null
-
isSubjectModifiable
Returns an Boolean instance with the value 'true' if the subject can be modified by the room participants, 'false' if not, ornull
if this information is reported by the room.- Returns:
- an boolean that is true if the subject can be modified by
participants or
null
-
getPubSub
An associated pubsub node for this room ornull
.- Returns:
- the associated pubsub node or
null
-
getLogsUrl
Returns the URL where archived discussion logs can be found ornull
if there is no such URL.- Returns:
- the URL where archived logs can be found or
null
-
getForm
Returns the form included in the extended disco info result ornull
if no such form was sent.- Returns:
- The room info form or
null
- See Also:
-