rocks.xmpp.extensions.muc.model

Class RoomInfo

java.lang.Object

rocks.xmpp.extensions.muc.model.RoomInfo

public final class RoomInfo
extends Object

Represents a standardized DataForm with form type http://jabber.org/protocol/muc#roominfo, which can be used to retrieve MUC room info.

Usage

To wrap an existing DataForm to retrieve standard data from it, use:

 
 RoomInfo roomInfo = new RoomInfo(dataForm);
 
 

To build a form:

 
 RoomInfo roomInfo = RoomInfo.builder()
     .maxHistoryMessages(50)
     .contacts(Arrays.asList(Jid.of("contact1"), Jid.of("contact2")))
     .description("The place for all good witches!")
     .language("en")
     .ldapGroup("cn=witches,dc=shakespeare,dc=lit")
     .logs(new URL("http://www.shakespeare.lit/chatlogs/coven/"))
     .currentNumberOfOccupants(45)
     .subject("Spells")
     .changeSubjectAllowed(true)
     .build();
 
 

See Also:

6.4 Querying for Room Information, 15.5.4 muc#roominfo FORM_TYPE

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RoomInfo.Builder A builder to build a room info form.

Field Summary

Fields

Modifier and Type	Field and Description
static String	FORM_TYPE

Constructor Summary

Constructors

Constructor and Description
RoomInfo(DataForm dataForm)

Method Summary

Modifier and Type	Method and Description
static RoomInfo.Builder	builder()
List<Jid>	getContacts() Gets the contact addresses (normally room owners).
Integer	getCurrentNumberOfOccupants() Gets the current number of occupants in the room.
DataForm	getDataForm() Gets the underlying data form.
String	getDescription() Gets a short description.
Locale	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.
Integer	getMaxHistoryMessages() Gets the maximum number of history messages returned by 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

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

Field Detail

FORM_TYPE

public static final String FORM_TYPE

See Also:

Constant Field Values

Constructor Detail

RoomInfo

public RoomInfo(DataForm dataForm)

Method Detail

builder

public static RoomInfo.Builder builder()

getMaxHistoryMessages

public Integer 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 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.

getDataForm

public DataForm getDataForm()

Gets the underlying data form.

Returns:

The underlying data form.