rocks.xmpp.extensions.muc

Class ChatRoom

java.lang.Object

rocks.xmpp.extensions.muc.ChatRoom

public final class ChatRoom
extends Object

Represents a chat room.

Author:

Christian Schudt

Method Summary

Modifier and Type	Method and Description
void	addInvitationDeclineListener(InvitationDeclineListener invitationDeclineListener) Adds a invitation decline listener, which allows to listen for invitation declines.
void	addMessageListener(MessageListener messageListener) Adds a message listener, which allows to listen for incoming messages in this room.
void	addOccupantListener(OccupantListener occupantListener) Adds an occupant listener, which allows to listen for presence changes of occupants, e.g.
void	addSubjectChangeListener(SubjectChangeListener subjectChangeListener) Adds a subject change listener, which allows to listen for subject changes.
void	changeAffiliation(Affiliation affiliation, rocks.xmpp.core.Jid user, String reason) Changes the affiliation for an user.
void	changeAffiliationsOrRoles(List<Item> items) Changes multiple affiliations or roles.
void	changeAvailabilityStatus(rocks.xmpp.core.stanza.model.AbstractPresence.Show show, String status) Changes the availability status.
void	changeNickname(String newNickname) Changes the nickname.
void	changeRole(Role role, String nickname, String reason) Changes the role for an occupant.
void	changeSubject(String subject) Changes the room subject.
void	createRoom() Creates an instant room.
void	destroy(String reason) Destroys the room.
List<String>	discoverOccupants() Gets the occupants in this room, i.e. their nicknames.
void	enter(String nick) Enters the room.
void	enter(String nick, History history) Enters the room and requests history messages.
void	enter(String nick, String password) Enters the room with a password.
void	enter(String nick, String password, History history) Enters the room with a password and requests history messages.
void	exit() Exits the room.
void	exit(String message) Exits the room with a custom message.
rocks.xmpp.core.Jid	getAddress() Gets the room address.
List<? extends Item>	getBanList() Gets the ban list.
rocks.xmpp.extensions.data.model.DataForm	getConfigurationForm() Gets the configuration form for the room.
List<? extends Item>	getMembers() Gets the members of the room.
List<? extends Item>	getModerators() Gets the moderators.
String	getName() Gets the name for this room.
Occupant	getOccupant(String nickname) Gets an occupant by nickname.
Collection<Occupant>	getOccupants() Gets the occupants, while being in the room.
rocks.xmpp.extensions.data.model.DataForm	getRegistrationForm() Gets the data form necessary to register with the room.
String	getReservedNickname() Gets your reserved room nickname.
RoomInfo	getRoomInfo() Gets the room information for this chat room.
List<? extends Item>	getVoiceList() Gets the voice list.
void	invite(rocks.xmpp.core.Jid invitee, String reason) Invites another user to the room.
void	invite(rocks.xmpp.core.Jid invitee, String reason, boolean direct)
void	removeInvitationDeclineListener(InvitationDeclineListener invitationDeclineListener) Removes a previously added invitation decline listener.
void	removeMessageListener(MessageListener messageListener) Removes a previously added message listener.
void	removeOccupantListener(OccupantListener occupantListener) Removes a previously added occupant listener.
void	removeSubjectChangeListener(SubjectChangeListener subjectChangeListener) Removes a previously added subject change listener.
void	requestVoice() Requests voice in a moderated room.
void	sendMessage(rocks.xmpp.core.stanza.model.client.Message message) Sends a message to the room.
void	sendMessage(String message) Sends a message to the room.
void	submitConfigurationForm(rocks.xmpp.extensions.data.model.DataForm dataForm) Submits the configuration form for this room.
void	submitRegistrationForm(rocks.xmpp.extensions.data.model.DataForm dataForm) Submits the registration form.
String	toString()

Methods inherited from class java.lang.Object

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

Method Detail

addInvitationDeclineListener

public void addInvitationDeclineListener(InvitationDeclineListener invitationDeclineListener)

Adds a invitation decline listener, which allows to listen for invitation declines.

Parameters:

invitationDeclineListener - The listener.

See Also:

removeInvitationDeclineListener(InvitationDeclineListener)

removeInvitationDeclineListener

public void removeInvitationDeclineListener(InvitationDeclineListener invitationDeclineListener)

Removes a previously added invitation decline listener.

Parameters:

invitationDeclineListener - The listener.

See Also:

addInvitationDeclineListener(InvitationDeclineListener)

addSubjectChangeListener

public void addSubjectChangeListener(SubjectChangeListener subjectChangeListener)

Adds a subject change listener, which allows to listen for subject changes.

Parameters:

subjectChangeListener - The listener.

See Also:

removeSubjectChangeListener(SubjectChangeListener)

removeSubjectChangeListener

public void removeSubjectChangeListener(SubjectChangeListener subjectChangeListener)

Removes a previously added subject change listener.

Parameters:

subjectChangeListener - The listener.

See Also:

addSubjectChangeListener(SubjectChangeListener)

addMessageListener

public void addMessageListener(MessageListener messageListener)

Adds a message listener, which allows to listen for incoming messages in this room.

Parameters:

messageListener - The listener.

See Also:

removeMessageListener(rocks.xmpp.core.stanza.MessageListener)

removeMessageListener

public void removeMessageListener(MessageListener messageListener)

Removes a previously added message listener.

Parameters:

messageListener - The listener.

See Also:

addMessageListener(rocks.xmpp.core.stanza.MessageListener)

addOccupantListener

public void addOccupantListener(OccupantListener occupantListener)

Adds an occupant listener, which allows to listen for presence changes of occupants, e.g. "joins" and "leaves".

Parameters:

occupantListener - The listener.

See Also:

removeOccupantListener(OccupantListener)

removeOccupantListener

public void removeOccupantListener(OccupantListener occupantListener)

Removes a previously added occupant listener.

Parameters:

occupantListener - The listener.

See Also:

addOccupantListener(OccupantListener)

enter

public void enter(String nick)
           throws rocks.xmpp.core.XmppException

Enters the room.

Parameters:

nick - The nickname.

Throws:

rocks.xmpp.core.stanza.model.StanzaException - If the entity returned a stanza error.

NoResponseException - If the entity did not respond.

rocks.xmpp.core.XmppException

enter

public void enter(String nick,
                  String password)
           throws rocks.xmpp.core.XmppException

Enters the room with a password.

Parameters:

nick - The nickname.

password - The password.

Throws:

rocks.xmpp.core.stanza.model.StanzaException - If the entity returned a stanza error.

NoResponseException - If the entity did not respond.

rocks.xmpp.core.XmppException

enter

public void enter(String nick,
                  History history)
           throws rocks.xmpp.core.XmppException

Enters the room and requests history messages.

Parameters:

nick - The nickname.

history - The history.

Throws:

rocks.xmpp.core.stanza.model.StanzaException - If the entity returned a stanza error.

NoResponseException - If the entity did not respond.

rocks.xmpp.core.XmppException

enter

public void enter(String nick,
                  String password,
                  History history)
           throws rocks.xmpp.core.XmppException

Enters the room with a password and requests history messages.

Parameters:

nick - The nickname.

password - The password.

history - The history.

Throws:

rocks.xmpp.core.stanza.model.StanzaException - If the entity returned a stanza error.

NoResponseException - If the entity did not respond.

rocks.xmpp.core.XmppException

changeSubject

public void changeSubject(String subject)
                   throws rocks.xmpp.core.XmppException

Changes the room subject.

Parameters:

subject - The subject.

Throws:

rocks.xmpp.core.stanza.model.StanzaException - If the entity returned a stanza error.

NoResponseException - If the entity did not respond.

rocks.xmpp.core.XmppException

sendMessage

public void sendMessage(String message)

Sends a message to the room.

Parameters:

message - The message text.

sendMessage

public void sendMessage(rocks.xmpp.core.stanza.model.client.Message message)

Sends a message to the room.

Parameters:

message - The message.

changeNickname

public void changeNickname(String newNickname)
                    throws rocks.xmpp.core.XmppException

Changes the nickname.

Parameters:

newNickname - The new nickname.

Throws:

rocks.xmpp.core.stanza.model.StanzaException - If the entity returned a stanza error.

NoResponseException - If the entity did not respond.

rocks.xmpp.core.XmppException

See Also:

7.6 Changing Nickname

changeAvailabilityStatus

public void changeAvailabilityStatus(rocks.xmpp.core.stanza.model.AbstractPresence.Show show,
                                     String status)

Changes the availability status.

Parameters:

show - The 'show' value.

status - The status.

See Also:

7.7 Changing Availability Status

invite

public void invite(rocks.xmpp.core.Jid invitee,
                   String reason)

Invites another user to the room. The invitation will be mediated by the room.

Parameters:

invitee - The invitee.

reason - The reason.

See Also:

7.8 Inviting Another User to a Room

invite

public void invite(rocks.xmpp.core.Jid invitee,
                   String reason,
                   boolean direct)

Parameters:

invitee - The invitee.

reason - The reason.

direct - True, if the message is sent directly to the invitee; false if it is mediated by the room.

See Also:

7.8.1 Direct Invitation, 7.8.2 Mediated Invitation

getRegistrationForm

public rocks.xmpp.extensions.data.model.DataForm getRegistrationForm()
                                                              throws rocks.xmpp.core.XmppException

Gets the data form necessary to register with the room.

Returns:

The data form.

Throws:

rocks.xmpp.core.stanza.model.StanzaException - If the entity returned a stanza error.

NoResponseException - If the entity did not respond.

rocks.xmpp.core.XmppException

See Also:

7.10 Registering with a Room, RoomRegistrationForm

submitRegistrationForm

public void submitRegistrationForm(rocks.xmpp.extensions.data.model.DataForm dataForm)
                            throws rocks.xmpp.core.XmppException

Submits the registration form.

Parameters:

dataForm - The data form.

Throws:

rocks.xmpp.core.stanza.model.StanzaException - If the entity returned a stanza error.

NoResponseException - If the entity did not respond.

rocks.xmpp.core.XmppException

See Also:

7.10 Registering with a Room, RoomRegistrationForm

getReservedNickname

public String getReservedNickname()
                           throws rocks.xmpp.core.XmppException

Gets your reserved room nickname.

Returns:

The reserved nickname or null, if you don't have a reserved nickname.

Throws:

rocks.xmpp.core.stanza.model.StanzaException - If the entity returned a stanza error.

NoResponseException - If the entity did not respond.

rocks.xmpp.core.XmppException

requestVoice

public void requestVoice()

Requests voice in a moderated room.

See Also:

7.13 Requesting Voice

exit

public void exit()

Exits the room.

See Also:

7.14 Exiting a Room

exit

public void exit(String message)

Exits the room with a custom message.

Parameters:

message - The exit message.

See Also:

7.14 Exiting a Room

getVoiceList

public List<? extends Item> getVoiceList()
                                  throws rocks.xmpp.core.XmppException

Gets the voice list.

Returns:

The voice list.

Throws:

rocks.xmpp.core.stanza.model.StanzaException - If the entity returned a stanza error.

NoResponseException - If the entity did not respond.

rocks.xmpp.core.XmppException

See Also:

8.5 Modifying the Voice List

changeAffiliationsOrRoles

public void changeAffiliationsOrRoles(List<Item> items)
                               throws rocks.xmpp.core.XmppException

Changes multiple affiliations or roles.

Parameters:

items - The items.

Throws:

rocks.xmpp.core.stanza.model.StanzaException - If the entity returned a stanza error.

NoResponseException - If the entity did not respond.

rocks.xmpp.core.XmppException

See Also:

8.5 Modifying the Voice List, 9.5 Modifying the Member List, 9.8 Modifying the Moderator List, 10.5 Modifying the Owner List, 10.8 Modifying the Admin List

getBanList

public List<? extends Item> getBanList()
                                throws rocks.xmpp.core.XmppException

Gets the ban list.

Returns:

The ban list.

Throws:

rocks.xmpp.core.stanza.model.StanzaException - If the chat service returned a stanza error.

NoResponseException - If the chat service did not respond.

rocks.xmpp.core.XmppException

See Also:

9.2 Modifying the Ban List

changeAffiliation

public void changeAffiliation(Affiliation affiliation,
                              rocks.xmpp.core.Jid user,
                              String reason)
                       throws rocks.xmpp.core.XmppException

Changes the affiliation for an user.

Use this method for one of the following use cases:

• Banning a User (affiliation = Affiliation.OUTCAST)
• Granting Membership (affiliation = Affiliation.MEMBER)
• Revoking Membership (affiliation = Affiliation.NONE)
• Granting Admin Status (affiliation = Affiliation.ADMIN)
• Revoking Admin Status (affiliation = Affiliation.MEMBER)
• Granting Owner Status (affiliation = Affiliation.OWNER)
• Revoking Owner Status (affiliation = Affiliation.ADMIN)

Parameters:

affiliation - The new affiliation for the user.

user - The user.

reason - The reason.

Throws:

rocks.xmpp.core.stanza.model.StanzaException - If the chat service returned a stanza error.

NoResponseException - If the chat service did not respond.

rocks.xmpp.core.XmppException

See Also:

9.1 Banning a User, 9.3 Granting Membership, 9.4 Revoking Membership, 10.3 Granting Owner Status, 10.4 Revoking Owner Status, 10.6 Granting Admin Status, 10.7 Revoking Admin Status

changeRole

public void changeRole(Role role,
                       String nickname,
                       String reason)
                throws rocks.xmpp.core.XmppException

Changes the role for an occupant.

Use this method for one of the following use cases:

• Kicking an Occupant (role = Role.NONE)
• Granting Voice to a Visitor (role = Role.PARTICIPANT)
• Revoking Voice from a Participant (affiliation = Role.VISITOR)
• Granting Moderator Status (role = Role.MODERATOR)
• Revoking Moderator Status (role = Role.PARTICIPANT)

Parameters:

role - The new role for the user.

nickname - The occupant's nickname.

reason - The reason.

Throws:

rocks.xmpp.core.stanza.model.StanzaException - If the chat service returned a stanza error.

NoResponseException - If the chat service did not respond.

rocks.xmpp.core.XmppException

See Also:

8.2 Kicking an Occupant, 8.3 Granting Voice to a Visitor, 8.4 Revoking Voice from a Participant, 9.6 Granting Moderator Status, 9.7 Revoking Moderator Status

getMembers

public List<? extends Item> getMembers()
                                throws rocks.xmpp.core.XmppException

Gets the members of the room.

In the context of a members-only room, the member list is essentially a "whitelist" of people who are allowed to enter the room.

In the context of an open room, the member list is simply a list of users (bare JID and reserved nick) who are registered with the room.

Returns:

The members.

Throws:

rocks.xmpp.core.stanza.model.StanzaException - If the chat service returned a stanza error.

NoResponseException - If the chat service did not respond.

rocks.xmpp.core.XmppException

See Also:

9.5 Modifying the Member List

getModerators

public List<? extends Item> getModerators()
                                   throws rocks.xmpp.core.XmppException

Gets the moderators.

Returns:

The moderators.

Throws:

rocks.xmpp.core.stanza.model.StanzaException - If the chat service returned a stanza error.

NoResponseException - If the chat service did not respond.

rocks.xmpp.core.XmppException

See Also:

9.8 Modifying the Moderator List

createRoom

public void createRoom()
                throws rocks.xmpp.core.XmppException

Creates an instant room.

Throws:

rocks.xmpp.core.stanza.model.StanzaException - If the entity returned a stanza error.

NoResponseException - If the entity did not respond.

rocks.xmpp.core.XmppException

See Also:

10.1.2 Creating an Instant Room

getRoomInfo

public RoomInfo getRoomInfo()
                     throws rocks.xmpp.core.XmppException

Gets the room information for this chat room.

Returns:

The room info.

Throws:

rocks.xmpp.core.stanza.model.StanzaException - If the chat service returned a stanza error.

NoResponseException - If the chat service did not respond.

rocks.xmpp.core.XmppException

See Also:

6.4 Querying for Room Information

discoverOccupants

public List<String> discoverOccupants()
                               throws rocks.xmpp.core.XmppException

Gets the occupants in this room, i.e. their nicknames. This method should be used, when you are not yet in the room.

Returns:

The occupants.

Throws:

rocks.xmpp.core.stanza.model.StanzaException - If the chat service returned a stanza error.

NoResponseException - If the chat service did not respond.

rocks.xmpp.core.XmppException

See Also:

6.5 Querying for Room Items, getOccupants()

getOccupants

public Collection<Occupant> getOccupants()

Gets the occupants, while being in the room.

Returns:

The occupants.

getOccupant

public Occupant getOccupant(String nickname)

Gets an occupant by nickname.

Parameters:

nickname - The occupant's nickname.

Returns:

The occupant.

getConfigurationForm

public rocks.xmpp.extensions.data.model.DataForm getConfigurationForm()
                                                               throws rocks.xmpp.core.XmppException

Gets the configuration form for the room. You can wrap the form into RoomConfigurationForm for easier processing.

Use this method if you want to create a reserved room or configure an existing room.

Returns:

The configuration form.

Throws:

rocks.xmpp.core.stanza.model.StanzaException - If the chat service returned a stanza error.

NoResponseException - If the chat service did not respond.

rocks.xmpp.core.XmppException

See Also:

RoomConfigurationForm, 10.1.3 Creating a Reserved Room, submitConfigurationForm(rocks.xmpp.extensions.data.model.DataForm)

submitConfigurationForm

public void submitConfigurationForm(rocks.xmpp.extensions.data.model.DataForm dataForm)
                             throws rocks.xmpp.core.XmppException

Submits the configuration form for this room.

Parameters:

dataForm - The data form.

Throws:

rocks.xmpp.core.stanza.model.StanzaException - If the chat service returned a stanza error.

NoResponseException - If the chat service did not respond.

rocks.xmpp.core.XmppException

See Also:

10.1.3 Creating a Reserved Room, getConfigurationForm()

getName

public String getName()

Gets the name for this room.

Returns:

The room name.

destroy

public void destroy(String reason)
             throws rocks.xmpp.core.XmppException

Destroys the room.

Parameters:

reason - The reason for the room destruction.

Throws:

rocks.xmpp.core.stanza.model.StanzaException - If the chat service returned a stanza error.

NoResponseException - If the chat service did not respond.

rocks.xmpp.core.XmppException

See Also:

10.9 Destroying a Room

getAddress

public rocks.xmpp.core.Jid getAddress()

Gets the room address.

Returns:

The room address.

toString

public String toString()

Overrides:

toString in class Object