+ * the room. {@link #sendConfigurationForm(Form)}
* * To create a "Reserved Room", that means a room manually configured by the room creator * before anyone is allowed to enter, the room's owner should complete and send a form after * creating the room. Once the completed configutation form is sent to the server, the server - * will unlock the room. (@see MultiUserChat.sendConfigurationForm(Form)) + * will unlock the room. {@link #sendConfigurationForm(Form)} * * @param nickname the nickname to use. * @throws XMPPException if the room couldn't be created for some reason @@ -442,10 +442,10 @@ public class MultiUserChat { } /** - * Returns true if currently in the group chat (after calling the {@link - * #join(String)} method. + * Returns true if currently in the multi user chat (after calling the {@link + * #join(String)} method). * - * @return true if currently in the group chat room. + * @return true if currently in the multi user chat room. */ public boolean isJoined() { return joined; @@ -798,9 +798,9 @@ public class MultiUserChat { * user joins the room a message with the current room's subject will be received.
* * To be notified every time the room's subject change you should add a listener - * to this room. (@see addSubjectUpdatedListener(SubjectUpdatedListener))
+ * to this room. {@link #addSubjectUpdatedListener(SubjectUpdatedListener)}
*
- * To change the room's subject use changeSubject(String).
+ * To change the room's subject use {@link #changeSubject(String)}.
*
* @return the room's subject or null if the user hasn't joined the room or the
* room does not have a subject yet.
@@ -1451,6 +1451,17 @@ public class MultiUserChat {
connection.addPacketListener(listener, presenceFilter);
}
+ /**
+ * Remoces a packet listener that was being notified of any new Presence packets
+ * sent to the group chat.
+ *
+ * @param listener a packet listener that was being notified of any presence packets
+ * sent to the group chat.
+ */
+ public void removeParticipantListener(PacketListener listener) {
+ connection.removePacketListener(listener);
+ }
+
/**
* Sends a message to the chat room.
*
@@ -1547,6 +1558,17 @@ public class MultiUserChat {
connection.addPacketListener(listener, messageFilter);
}
+ /**
+ * Removes a packet listener that was being notified of any new messages in the
+ * multi user chat. Only "group chat" messages addressed to this multi user chat were
+ * being delivered to the listener.
+ *
+ * @param listener a packet listener.
+ */
+ public void removeMessageListener(PacketListener listener) {
+ connection.removePacketListener(listener);
+ }
+
/**
* Changes the subject within the room. As a default, only users with a role of "moderator"
* are allowed to change the subject in a room. Although some rooms may be configured to
@@ -1626,6 +1648,12 @@ public class MultiUserChat {
return null;
}
+ /**
+ * Adds a listener that will be notified of changes in your status in the room
+ * such as the user being kicked, banned, or granted admin permissions.
+ *
+ * @param listener a user status listener.
+ */
public void addUserStatusListener(UserStatusListener listener) {
synchronized (userStatusListeners) {
if (!userStatusListeners.contains(listener)) {
@@ -1634,6 +1662,12 @@ public class MultiUserChat {
}
}
+ /**
+ * Removes a listener that was being notified of changes in your status in the room
+ * such as the user being kicked, banned, or granted admin permissions.
+ *
+ * @param listener a user status listener.
+ */
public void removeUserStatusListener(UserStatusListener listener) {
synchronized (userStatusListeners) {
userStatusListeners.remove(listener);
@@ -1666,6 +1700,12 @@ public class MultiUserChat {
}
}
+ /**
+ * Adds a listener that will be notified of changes in participants status in the room
+ * such as the user being kicked, banned, or granted admin permissions.
+ *
+ * @param listener a participant status listener.
+ */
public void addParticipantStatusListener(ParticipantStatusListener listener) {
synchronized (participantStatusListeners) {
if (!participantStatusListeners.contains(listener)) {
@@ -1674,6 +1714,12 @@ public class MultiUserChat {
}
}
+ /**
+ * Removes a listener that was being notified of changes in participants status in the room
+ * such as the user being kicked, banned, or granted admin permissions.
+ *
+ * @param listener a participant status listener.
+ */
public void removeParticipantStatusListener(ParticipantStatusListener listener) {
synchronized (participantStatusListeners) {
participantStatusListeners.remove(listener);
diff --git a/source/org/jivesoftware/smackx/NodeInformationProvider.java b/source/org/jivesoftware/smackx/NodeInformationProvider.java
index 723d242c8..c6d8ebbec 100644
--- a/source/org/jivesoftware/smackx/NodeInformationProvider.java
+++ b/source/org/jivesoftware/smackx/NodeInformationProvider.java
@@ -65,9 +65,9 @@ import java.util.Iterator;
public interface NodeInformationProvider {
/**
- * Returns an Iterator on the Items (@see DiscoverItems.Item) defined in the node. For example,
- * the MUC protocol specifies that an XMPP client should answer an Item for each joined room
- * when asked for the rooms where the use has joined.
+ * Returns an Iterator on the Items {@link org.jivesoftware.smackx.packet.DiscoverItems.Item}
+ * defined in the node. For example, the MUC protocol specifies that an XMPP client should
+ * answer an Item for each joined room when asked for the rooms where the use has joined.
*
* @return an Iterator on the Items defined in the node.
*/