rocks.xmpp.extensions.muc

Class RoomInfo

java.lang.Object

rocks.xmpp.extensions.muc.RoomInfo

public final class RoomInfo
extends Object

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.

Author:

Christian Schudt

See Also:

6.4 Querying for Room Information

Constructor Summary

Constructors

Constructor and Description
RoomInfo(rocks.xmpp.extensions.disco.model.info.Identity identity, Set<MucFeature> features, RoomInfoForm roomInfoForm)

Method Summary

Modifier and Type	Method and Description
List<rocks.xmpp.core.Jid>	getContacts() Gets the contact addresses (normally, room owner or owners).
int	getCurrentNumberOfOccupants() Gets the current number of occupants in the room.
String	getDescription() Gets a short description.
Set<MucFeature>	getFeatures() Gets the features of this room.
String	getLanguage() Gets the natural language for room discussions.
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.
URL	getLogs() Gets an URL for archived discussion logs.
int	getMaxHistoryMessages() Gets the maximum number of history messages returned by the room.
String	getName() Gets the name of the room.
String	getSubject() Gets the current discussion topic.
boolean	isChangeSubjectAllowed() Indicates, whether the room subject can be modified by participants.

Methods inherited from class java.lang.Object

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

Constructor Detail

RoomInfo

public RoomInfo(rocks.xmpp.extensions.disco.model.info.Identity identity,
                Set<MucFeature> features,
                RoomInfoForm roomInfoForm)

Method Detail

getFeatures

public Set<MucFeature> getFeatures()

Gets the features of this room.

Returns:

The features.

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<rocks.xmpp.core.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 String 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 int 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.