Package org.jivesoftware.smackx.muc

Interface UserStatusListener

public interface UserStatusListener

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 or the room is destroyed.

Note that the methods kicked(Jid, String), banned(Jid, String) and roomDestroyed(MultiUserChat, String, String) will be called before the generic removed(MUCUser, Presence) callback will be invoked. The generic removed(MUCUser, Presence) callback will be invoked every time the user was removed from the MUC involuntarily. It is hence the recommended callback to listen for and act upon.

Method Summary

Modifier and Type	Method	Description
default void	adminGranted()	Called when an owner grants administrator privileges to your user.
default void	adminRevoked()	Called when an owner revokes administrator privileges from your user.
default void	banned(Jid actor, String reason)	Called when an administrator or owner banned your user from the room.
default void	kicked(Jid actor, String reason)	Called when a moderator kicked your user from the room.
default void	membershipGranted()	Called when an administrator grants your user membership to the room.
default void	membershipRevoked()	Called when an administrator revokes your user membership to the room.
default void	moderatorGranted()	Called when an administrator grants moderator privileges to your user.
default void	moderatorRevoked()	Called when an administrator revokes moderator privileges from your user.
default void	ownershipGranted()	Called when an owner grants to your user ownership on the room.
default void	ownershipRevoked()	Called when an owner revokes from your user ownership on the room.
default void	removed(MUCUser mucUser, Presence presence)	Called when a user is involuntarily removed from the room.
default void	roomDestroyed(MultiUserChat alternateMUC, String password, String reason)	Called when the room is destroyed.
default void	voiceGranted()	Called when a moderator grants voice to your user.
default void	voiceRevoked()	Called when a moderator revokes voice from your user.

Method Details

kicked

default void kicked(Jid actor,
 String reason)

Called when a moderator kicked your user from the room. This means that you are no longer participating in the room.

Parameters:

actor - the moderator that kicked your user from the room (e.g. user@host.org).

reason - the reason provided by the actor to kick you from the room.

See Also:

• removed(MUCUser, Presence)

voiceGranted

default void voiceGranted()

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.

voiceRevoked

default void voiceRevoked()

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.

banned

default void banned(Jid actor,
 String reason)

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.

Parameters:

actor - the administrator that banned your user (e.g. user@host.org).

reason - the reason provided by the administrator to banned you.

See Also:

• removed(MUCUser, Presence)

removed

default void removed(MUCUser mucUser,
 Presence presence)

Called when a user is involuntarily removed from the room.

Parameters:

mucUser - the optional muc#user extension element

presence - the carrier presence

Since:

4.4.0

membershipGranted

default void membershipGranted()

Called when an administrator grants your user membership to the room. This means that you will be able to join the members-only room.

membershipRevoked

default void membershipRevoked()

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.

moderatorGranted

default void moderatorGranted()

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 participant privileges.

moderatorRevoked

default void moderatorRevoked()

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 participant privileges.

ownershipGranted

default void ownershipGranted()

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.

ownershipRevoked

default void ownershipRevoked()

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.

adminGranted

default void adminGranted()

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.

adminRevoked

default void adminRevoked()

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.

roomDestroyed

default void roomDestroyed(MultiUserChat alternateMUC,
 String password,
 String reason)

Called when the room is destroyed.

Parameters:

alternateMUC - an alternate MultiUserChat, may be null.

password - a password for the alternative MultiUserChat, may be null.

reason - the reason why the room was closed, may be null.

See Also:

• removed(MUCUser, Presence)