ChatRoom (Babbler 0.5.1)

java.lang.Object
- rocks.xmpp.core.chat.Chat
- - rocks.xmpp.extensions.muc.ChatRoom

All Implemented Interfaces:: Comparable<ChatRoom>

public final class ChatRoom
extends Chat
implements Comparable<ChatRoom>

Represents a chat room.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addInvitationDeclineListener(InvitationDeclineListener invitationDeclineListener)` Adds a invitation decline listener, which allows to listen for invitation declines.
`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, Jid user, String reason)` Changes the affiliation for an user.
`void`	`changeAffiliationsOrRoles(List<Item> items)` Changes multiple affiliations or roles.
`void`	`changeAvailabilityStatus(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.
`int`	`compareTo(ChatRoom o)` Compares this chat service first by their name and then by their service address.
`void`	`configure(RoomConfiguration roomConfiguration)` Configures this room.
`void`	`createRoom()` Creates an instant room.
`void`	`destroy(String reason)` Destroys the room.
`Set<Feature>`	`discoverAllowableTraffic()` Discovers the allowable traffic, i.e. the allowed extensions.
`List<String>`	`discoverOccupants()` Gets the occupants in this room, i.e. their nicknames.
`String`	`discoverReservedNickname()` Gets your reserved room nickname.
`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.
`Jid`	`getAddress()` Gets the room address.
`List<? extends Item>`	`getBanList()` Gets the ban list.
`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.
`DataForm`	`getRegistrationForm()` Gets the data form necessary to register with the room.
`RoomInformation`	`getRoomInformation()` Gets the room information for this chat room.
`List<? extends Item>`	`getVoiceList()` Gets the voice list.
`void`	`invite(Jid invitee, String reason)` Invites another user to the room.
`void`	`invite(Jid invitee, String reason, boolean direct)` Invites another user to the room.
`void`	`register(Registration registration)` Registers with the room.
`void`	`removeInvitationDeclineListener(InvitationDeclineListener invitationDeclineListener)` Removes a previously added invitation decline 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.
`Message`	`sendMessage(Message message)` Sends a message to the room.
`Message`	`sendMessage(String message)` Sends a message to the room.
`void`	`submitConfigurationForm(DataForm dataForm)` Deprecated. Use `configure(rocks.xmpp.extensions.muc.model.RoomConfiguration)`
`void`	`submitRegistrationForm(DataForm dataForm)` Deprecated. Use `register(rocks.xmpp.extensions.register.model.Registration)`
`String`	`toString()`

Methods inherited from class rocks.xmpp.core.chat.Chat
addInboundMessageListener, removeInboundMessageListener

Methods inherited from class java.lang.Object
equals, 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)
  - 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 XmppException
```
    Enters the room.
    
    Parameters:
    nick - The nickname.
    
    Throws:
    
    StanzaException - If the entity returned a stanza error.
    
    NoResponseException - If the entity did not respond.
    
    XmppException
  - enter
```
public void enter(String nick,
         String password)
           throws XmppException
```
    Enters the room with a password.
    
    Parameters:
    nick - The nickname.
    password - The password.
    
    Throws:
    
    StanzaException - If the entity returned a stanza error.
    
    NoResponseException - If the entity did not respond.
    
    XmppException
  - enter
```
public void enter(String nick,
         History history)
           throws XmppException
```
    Enters the room and requests history messages.
    
    Parameters:
    nick - The nickname.
    history - The history.
    
    Throws:
    
    StanzaException - If the entity returned a stanza error.
    
    NoResponseException - If the entity did not respond.
    
    XmppException
  - enter
```
public void enter(String nick,
         String password,
         History history)
           throws XmppException
```
    Enters the room with a password and requests history messages.
    
    Parameters:
    nick - The nickname.
    password - The password.
    history - The history.
    
    Throws:
    
    StanzaException - If the entity returned a stanza error.
    
    NoResponseException - If the entity did not respond.
    
    XmppException
  - changeSubject
```
public void changeSubject(String subject)
                   throws XmppException
```
    Changes the room subject.
    
    Parameters:
    subject - The subject.
    
    Throws:
    
    StanzaException - If the entity returned a stanza error.
    
    NoResponseException - If the entity did not respond.
    
    XmppException
  - sendMessage
```
public Message sendMessage(String message)
```
    Sends a message to the room.
    
    Specified by:
    
    sendMessage in class Chat
    
    Parameters:
    message - The message text.
    
    Returns:
    The sent message.
  - sendMessage
```
public Message sendMessage(Message message)
```
    Sends a message to the room.
    
    Specified by:
    
    sendMessage in class Chat
    
    Parameters:
    message - The message.
    
    Returns:
    The sent message.
  - changeNickname
```
public void changeNickname(String newNickname)
                    throws XmppException
```
    Changes the nickname.
    
    Parameters:
    newNickname - The new nickname.
    
    Throws:
    
    StanzaException - If the entity returned a stanza error.
    
    NoResponseException - If the entity did not respond.
    
    XmppException
    See Also:
    7.6 Changing Nickname
  - changeAvailabilityStatus
```
public void changeAvailabilityStatus(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(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(Jid invitee,
          String reason,
          boolean direct)
```
    Invites another user to the room. The invitation will be either mediated by the room or 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 DataForm getRegistrationForm()
                             throws XmppException
```
    Gets the data form necessary to register with the room.
    
    Returns:
    The data form.
    
    Throws:
    
    StanzaException - If the entity returned a stanza error.
    
    NoResponseException - If the entity did not respond.
    
    XmppException
    See Also:
    7.10 Registering with a Room, RoomRegistration
  - submitRegistrationForm
```
@Deprecated
public void submitRegistrationForm(DataForm dataForm)
                            throws XmppException
```
    Deprecated. Use register(rocks.xmpp.extensions.register.model.Registration)
    
    Submits the registration form.
    
    Parameters:
    dataForm - The data form.
    
    Throws:
    
    StanzaException - If the entity returned a stanza error.
    
    NoResponseException - If the entity did not respond.
    
    XmppException
    See Also:
    7.10 Registering with a Room, RoomRegistration
  - register
```
public void register(Registration registration)
              throws XmppException
```
    Registers with the room.
    
    Parameters:
    registration - The registration.
    
    Throws:
    
    StanzaException - If the entity returned a stanza error.
    
    NoResponseException - If the entity did not respond.
    
    XmppException
    See Also:
    7.10 Registering with a Room, RoomRegistration
  - discoverReservedNickname
```
public String discoverReservedNickname()
                                throws XmppException
```
    Gets your reserved room nickname.
    
    Returns:
    The reserved nickname or null, if you don't have a reserved nickname.
    
    Throws:
    
    StanzaException - If the entity returned a stanza error.
    
    NoResponseException - If the entity did not respond.
    
    XmppException
  - requestVoice
```
public void requestVoice()
```
    Requests voice in a moderated room.
    
    See Also:
    7.13 Requesting Voice
  - exit
```
public void exit()
          throws XmppException
```
    Exits the room.
    
    Throws:
    
    StanzaException - If the entity returned a stanza error.
    
    NoResponseException - If the entity did not respond.
    
    XmppException
    See Also:
    7.14 Exiting a Room
  - exit
```
public void exit(String message)
          throws XmppException
```
    Exits the room with a custom message.
    
    Parameters:
    message - The exit message.
    
    Throws:
    
    StanzaException - If the entity returned a stanza error.
    
    NoResponseException - If the entity did not respond.
    
    XmppException
    See Also:
    7.14 Exiting a Room
  - getVoiceList
```
public List<? extends Item> getVoiceList()
                                  throws XmppException
```
    Gets the voice list.
    
    Returns:
    The voice list.
    
    Throws:
    
    StanzaException - If the entity returned a stanza error.
    
    NoResponseException - If the entity did not respond.
    
    XmppException
    See Also:
    8.5 Modifying the Voice List
  - changeAffiliationsOrRoles
```
public void changeAffiliationsOrRoles(List<Item> items)
                               throws XmppException
```
    Changes multiple affiliations or roles.
    
    Parameters:
    items - The items.
    
    Throws:
    
    StanzaException - If the entity returned a stanza error.
    
    NoResponseException - If the entity did not respond.
    
    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 XmppException
```
    Gets the ban list.
    
    Returns:
    The ban list.
    
    Throws:
    
    StanzaException - If the chat service returned a stanza error.
    
    NoResponseException - If the chat service did not respond.
    
    XmppException
    See Also:
    9.2 Modifying the Ban List
  - changeAffiliation
```
public void changeAffiliation(Affiliation affiliation,
                     Jid user,
                     String reason)
                       throws 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:
    
    StanzaException - If the chat service returned a stanza error.
    
    NoResponseException - If the chat service did not respond.
    
    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 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:
    
    StanzaException - If the chat service returned a stanza error.
    
    NoResponseException - If the chat service did not respond.
    
    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 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:
    
    StanzaException - If the chat service returned a stanza error.
    
    NoResponseException - If the chat service did not respond.
    
    XmppException
    See Also:
    9.5 Modifying the Member List
  - getModerators
```
public List<? extends Item> getModerators()
                                   throws XmppException
```
    Gets the moderators.
    
    Returns:
    The moderators.
    
    Throws:
    
    StanzaException - If the chat service returned a stanza error.
    
    NoResponseException - If the chat service did not respond.
    
    XmppException
    See Also:
    9.8 Modifying the Moderator List
  - createRoom
```
public void createRoom()
                throws XmppException
```
    Creates an instant room.
    
    Throws:
    
    StanzaException - If the entity returned a stanza error.
    
    NoResponseException - If the entity did not respond.
    
    XmppException
    See Also:
    10.1.2 Creating an Instant Room
  - getRoomInformation
```
public RoomInformation getRoomInformation()
                                   throws XmppException
```
    Gets the room information for this chat room.
    
    Returns:
    The room info.
    
    Throws:
    
    StanzaException - If the chat service returned a stanza error.
    
    NoResponseException - If the chat service did not respond.
    
    XmppException
    See Also:
    6.4 Querying for Room Information
  - discoverOccupants
```
public List<String> discoverOccupants()
                               throws 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:
    
    StanzaException - If the chat service returned a stanza error.
    
    NoResponseException - If the chat service did not respond.
    
    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 DataForm getConfigurationForm()
                              throws XmppException
```
    Gets the configuration form for the room. You can wrap the form into RoomConfiguration for easier processing.
    Use this method if you want to create a reserved room or configure an existing room.
    
    Returns:
    The configuration form.
    
    Throws:
    
    StanzaException - If the chat service returned a stanza error.
    
    NoResponseException - If the chat service did not respond.
    
    XmppException
    See Also:
    RoomConfiguration, 10.1.3 Creating a Reserved Room, configure(rocks.xmpp.extensions.muc.model.RoomConfiguration)
  - submitConfigurationForm
```
@Deprecated
public void submitConfigurationForm(DataForm dataForm)
                             throws XmppException
```
    Deprecated. Use configure(rocks.xmpp.extensions.muc.model.RoomConfiguration)
    
    Submits the configuration form for this room.
    
    Parameters:
    dataForm - The data form.
    
    Throws:
    
    StanzaException - If the chat service returned a stanza error.
    
    NoResponseException - If the chat service did not respond.
    
    XmppException
    See Also:
    10.1.3 Creating a Reserved Room, getConfigurationForm()
  - configure
```
public void configure(RoomConfiguration roomConfiguration)
               throws XmppException
```
    Configures this room.
    
    Parameters:
    roomConfiguration - The room configuration form.
    
    Throws:
    
    StanzaException - If the chat service returned a stanza error.
    
    NoResponseException - If the chat service did not respond.
    
    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 XmppException
```
    Destroys the room.
    
    Parameters:
    reason - The reason for the room destruction.
    
    Throws:
    
    StanzaException - If the chat service returned a stanza error.
    
    NoResponseException - If the chat service did not respond.
    
    XmppException
    See Also:
    10.9 Destroying a Room
  - getAddress
```
public Jid getAddress()
```
    Gets the room address.
    
    Returns:
    The room address.
  - discoverAllowableTraffic
```
public Set<Feature> discoverAllowableTraffic()
                                      throws XmppException
```
    Discovers the allowable traffic, i.e. the allowed extensions.
    
    Returns:
    The list of allowable features.
    
    Throws:
    
    StanzaException - If the chat service returned a stanza error.
    
    NoResponseException - If the chat service did not respond.
    
    XmppException
    See Also:
    17.1.1 Allowable Traffic
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object
  - compareTo
```
public int compareTo(ChatRoom o)
```
    Compares this chat service first by their name and then by their service address.
    
    Specified by:
    
    compareTo in interface Comparable<ChatRoom>
    
    Parameters:
    o - The other chat service.
    
    Returns:
    The comparison result.

Class ChatRoom

Method Summary

Methods inherited from class rocks.xmpp.core.chat.Chat

Methods inherited from class java.lang.Object

Method Detail

addInvitationDeclineListener

removeInvitationDeclineListener

addSubjectChangeListener

removeSubjectChangeListener

addOccupantListener

removeOccupantListener

enter

enter

enter

enter

changeSubject

sendMessage

sendMessage

changeNickname

changeAvailabilityStatus

invite

invite

getRegistrationForm

submitRegistrationForm

register

discoverReservedNickname

requestVoice

exit

exit

getVoiceList

changeAffiliationsOrRoles

getBanList

changeAffiliation

changeRole

getMembers

getModerators

createRoom

getRoomInformation

discoverOccupants

getOccupants

getOccupant

getConfigurationForm

submitConfigurationForm

configure

getName

destroy

getAddress

discoverAllowableTraffic

toString

compareTo