aboutsummaryrefslogtreecommitdiff
path: root/src/org/jivesoftware/smackx/muc/UserStatusListener.java
diff options
context:
space:
mode:
Diffstat (limited to 'src/org/jivesoftware/smackx/muc/UserStatusListener.java')
-rw-r--r--src/org/jivesoftware/smackx/muc/UserStatusListener.java127
1 files changed, 127 insertions, 0 deletions
diff --git a/src/org/jivesoftware/smackx/muc/UserStatusListener.java b/src/org/jivesoftware/smackx/muc/UserStatusListener.java
new file mode 100644
index 0000000..27f0f58
--- /dev/null
+++ b/src/org/jivesoftware/smackx/muc/UserStatusListener.java
@@ -0,0 +1,127 @@
+/**
+ * $RCSfile$
+ * $Revision$
+ * $Date$
+ *
+ * Copyright 2003-2007 Jive Software.
+ *
+ * All rights reserved. Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+package org.jivesoftware.smackx.muc;
+
+/**
+ * A listener that is fired anytime your participant's status in a room is changed, such as the
+ * user being kicked, banned, or granted admin permissions.
+ *
+ * @author Gaston Dombiak
+ */
+public interface UserStatusListener {
+
+ /**
+ * Called when a moderator kicked your user from the room. This means that you are no longer
+ * participanting in the room.
+ *
+ * @param actor the moderator that kicked your user from the room (e.g. user@host.org).
+ * @param reason the reason provided by the actor to kick you from the room.
+ */
+ public abstract void kicked(String actor, String reason);
+
+ /**
+ * Called when a moderator grants voice to your user. This means that you were a visitor in
+ * the moderated room before and now you can participate in the room by sending messages to
+ * all occupants.
+ *
+ */
+ public abstract void voiceGranted();
+
+ /**
+ * Called when a moderator revokes voice from your user. This means that you were a
+ * participant in the room able to speak and now you are a visitor that can't send
+ * messages to the room occupants.
+ *
+ */
+ public abstract void voiceRevoked();
+
+ /**
+ * Called when an administrator or owner banned your user from the room. This means that you
+ * will no longer be able to join the room unless the ban has been removed.
+ *
+ * @param actor the administrator that banned your user (e.g. user@host.org).
+ * @param reason the reason provided by the administrator to banned you.
+ */
+ public abstract void banned(String actor, String reason);
+
+ /**
+ * Called when an administrator grants your user membership to the room. This means that you
+ * will be able to join the members-only room.
+ *
+ */
+ public abstract void membershipGranted();
+
+ /**
+ * Called when an administrator revokes your user membership to the room. This means that you
+ * will not be able to join the members-only room.
+ *
+ */
+ public abstract void membershipRevoked();
+
+ /**
+ * Called when an administrator grants moderator privileges to your user. This means that you
+ * will be able to kick users, grant and revoke voice, invite other users, modify room's
+ * subject plus all the partcipants privileges.
+ *
+ */
+ public abstract void moderatorGranted();
+
+ /**
+ * Called when an administrator revokes moderator privileges from your user. This means that
+ * you will no longer be able to kick users, grant and revoke voice, invite other users,
+ * modify room's subject plus all the partcipants privileges.
+ *
+ */
+ public abstract void moderatorRevoked();
+
+ /**
+ * Called when an owner grants to your user ownership on the room. This means that you
+ * will be able to change defining room features as well as perform all administrative
+ * functions.
+ *
+ */
+ public abstract void ownershipGranted();
+
+ /**
+ * Called when an owner revokes from your user ownership on the room. This means that you
+ * will no longer be able to change defining room features as well as perform all
+ * administrative functions.
+ *
+ */
+ public abstract void ownershipRevoked();
+
+ /**
+ * Called when an owner grants administrator privileges to your user. This means that you
+ * will be able to perform administrative functions such as banning users and edit moderator
+ * list.
+ *
+ */
+ public abstract void adminGranted();
+
+ /**
+ * Called when an owner revokes administrator privileges from your user. This means that you
+ * will no longer be able to perform administrative functions such as banning users and edit
+ * moderator list.
+ *
+ */
+ public abstract void adminRevoked();
+
+}