Uses of Interface
org.jivesoftware.openfire.muc.MUCRole

Packages that use MUCRole

Package	Description
org.jivesoftware.openfire.muc	Implementation of Multi-User Chat (XEP-0045).
org.jivesoftware.openfire.muc.cluster
org.jivesoftware.openfire.muc.spi	Implementation of Multi-User Chat (XEP-0045).

Uses of MUCRole in org.jivesoftware.openfire.muc

Methods in org.jivesoftware.openfire.muc that return MUCRole

Modifier and Type	Method and Description
MUCRole	MUCRoom.getOccupant(String nickname) Deprecated. Prefer MUCRoom.getOccupantsByNickname(String) instead (a user may be connected more than once)
MUCRole	MUCRoom.getOccupantByFullJID(org.xmpp.packet.JID jid) Returns the role of a given user in the room by his full JID or null if no role was found for the specified user.
MUCRole	MUCRoom.getRole() Obtain the role of the chat server (mainly for addressing messages and presence).
MUCRole	MUCRoom.joinRoom(String nickname, String password, HistoryRequest historyRequest, LocalMUCUser user, org.xmpp.packet.Presence presence) Joins the room using the given nickname.

Methods in org.jivesoftware.openfire.muc that return types with arguments of type MUCRole

Modifier and Type	Method and Description
Collection<MUCRole>	MUCRoom.getModerators() Returns a collection with the current list of room moderators.
Collection<MUCRole>	MultiUserChatService.getMUCRoles(org.xmpp.packet.JID user) Returns the list of MUCRole in all rooms for the specified user's session.
Collection<MUCRole>	MUCRoom.getOccupants() Obtain the roles of all users in the chatroom.
List<MUCRole>	MUCRoom.getOccupantsByBareJID(org.xmpp.packet.JID jid) Obtain the roles of a given user in the room by his bare JID.
List<MUCRole>	MUCRoom.getOccupantsByNickname(String nickname) Obtain the roles of a given user by nickname.
Collection<MUCRole>	MUCRoom.getParticipants() Returns a collection with the current list of room participants.

Methods in org.jivesoftware.openfire.muc with parameters of type MUCRole

Modifier and Type	Method and Description
List<org.xmpp.packet.Presence>	MUCRoom.addAdmin(org.xmpp.packet.JID jid, MUCRole senderRole) Adds a new user to the list of admins.
List<org.xmpp.packet.Presence>	MUCRoom.addAdmins(List<org.xmpp.packet.JID> newAdmins, MUCRole senderRole) Adds a list of users to the list of admins.
List<org.xmpp.packet.Presence>	MUCRoom.addMember(org.xmpp.packet.JID jid, String nickname, MUCRole senderRole) Adds a new user to the list of members.
org.xmpp.packet.Presence	MUCRoom.addModerator(org.xmpp.packet.JID fullJID, MUCRole senderRole) Changes the role of the user within the room to moderator.
List<org.xmpp.packet.Presence>	MUCRoom.addNone(org.xmpp.packet.JID jid, MUCRole senderRole) Removes the user from all the other affiliation list thus giving the user a NONE affiliation.
List<org.xmpp.packet.Presence>	MUCRoom.addOutcast(org.xmpp.packet.JID jid, String reason, MUCRole senderRole) Adds a new user to the list of outcast users.
List<org.xmpp.packet.Presence>	MUCRoom.addOwner(org.xmpp.packet.JID jid, MUCRole senderRole) Adds a new user to the list of owners.
List<org.xmpp.packet.Presence>	MUCRoom.addOwners(List<org.xmpp.packet.JID> newOwners, MUCRole senderRole) Adds a list of users to the list of owners.
org.xmpp.packet.Presence	MUCRoom.addParticipant(org.xmpp.packet.JID fullJID, String reason, MUCRole senderRole) Changes the role of the user within the room to participant.
org.xmpp.packet.Presence	MUCRoom.addVisitor(org.xmpp.packet.JID jid, MUCRole senderRole) Changes the role of the user within the room to visitor.
void	MUCRoom.changeSubject(org.xmpp.packet.Message packet, MUCRole role) Changes the room's subject if the occupant has enough permissions.
void	MUCRoom.leaveRoom(MUCRole leaveRole) Remove a member from the chat room.
void	MUCRoom.lock(MUCRole senderRole) Locks the room so that users cannot join the room.
void	MUCRoom.nicknameChanged(MUCRole occupantRole, org.xmpp.packet.Presence newPresence, String oldNick, String newNick) An event callback fired whenever an occupant changes his nickname within the chatroom.
void	MUCRoom.presenceUpdated(MUCRole occupantRole, org.xmpp.packet.Presence newPresence) An event callback fired whenever an occupant updated his presence in the chatroom.
void	HistoryRequest.sendHistory(MUCRole joinRole, MUCRoomHistory roomHistory) Sends the smallest amount of traffic that meets any combination of the requested criteria.
void	MUCRoom.sendInvitation(org.xmpp.packet.JID to, String reason, MUCRole role, List<org.dom4j.Element> extensions) Sends an invitation to a user.
void	MUCRoom.sendPrivatePacket(org.xmpp.packet.Packet packet, MUCRole senderRole) Sends a private packet to a selected occupant.
void	MUCRoom.sendPublicMessage(org.xmpp.packet.Message message, MUCRole senderRole) Sends a message to the all the occupants.
void	MUCRoom.unlock(MUCRole senderRole) Unlocks the room so that users can join the room.

Uses of MUCRole in org.jivesoftware.openfire.muc.cluster

Methods in org.jivesoftware.openfire.muc.cluster that return MUCRole

Modifier and Type	Method and Description
MUCRole	OccupantLeftEvent.getRole()

Constructors in org.jivesoftware.openfire.muc.cluster with parameters of type MUCRole

Constructor and Description
OccupantAddedEvent(LocalMUCRoom room, MUCRole occupant)
OccupantLeftEvent(LocalMUCRoom room, MUCRole role)
UpdateOccupant(LocalMUCRoom room, MUCRole role)

Constructor parameters in org.jivesoftware.openfire.muc.cluster with type arguments of type MUCRole

Constructor and Description
RoomInfo(LocalMUCRoom room, Collection<MUCRole> occupants)

Uses of MUCRole in org.jivesoftware.openfire.muc.spi

Classes in org.jivesoftware.openfire.muc.spi that implement MUCRole

Modifier and Type	Class and Description
class	LocalMUCRole Implementation of a local room occupant.
class	RemoteMUCRole Representation of a room occupant of a local room that is being hosted by another cluster node.

Methods in org.jivesoftware.openfire.muc.spi that return MUCRole

Modifier and Type	Method and Description
MUCRole	LocalMUCRoom.getOccupant(String nickname) Deprecated. Prefer LocalMUCRoom.getOccupantsByNickname(String) (user can be connected more than once)
MUCRole	LocalMUCRoom.getOccupantByFullJID(org.xmpp.packet.JID jid)
MUCRole	LocalMUCRoom.getRole()
MUCRole	LocalMUCRoom.joinRoom(String nickname, String password, HistoryRequest historyRequest, LocalMUCUser user, org.xmpp.packet.Presence presence)

Methods in org.jivesoftware.openfire.muc.spi that return types with arguments of type MUCRole

Modifier and Type	Method and Description
Collection<MUCRole>	LocalMUCRoom.getModerators()
Collection<MUCRole>	MultiUserChatServiceImpl.getMUCRoles(org.xmpp.packet.JID user)
Collection<MUCRole>	LocalMUCRoom.getOccupants()
List<MUCRole>	LocalMUCRoom.getOccupantsByBareJID(org.xmpp.packet.JID jid)
List<MUCRole>	LocalMUCRoom.getOccupantsByNickname(String nickname)
Collection<MUCRole>	LocalMUCRoom.getParticipants()

Methods in org.jivesoftware.openfire.muc.spi with parameters of type MUCRole

Modifier and Type	Method and Description
List<org.xmpp.packet.Presence>	LocalMUCRoom.addAdmin(org.xmpp.packet.JID jid, MUCRole sendRole)
List<org.xmpp.packet.Presence>	LocalMUCRoom.addAdmins(List<org.xmpp.packet.JID> newAdmins, MUCRole senderRole)
List<org.xmpp.packet.Presence>	LocalMUCRoom.addMember(org.xmpp.packet.JID jid, String nickname, MUCRole sendRole)
org.xmpp.packet.Presence	LocalMUCRoom.addModerator(org.xmpp.packet.JID jid, MUCRole senderRole)
List<org.xmpp.packet.Presence>	LocalMUCRoom.addNone(org.xmpp.packet.JID jid, MUCRole senderRole)
List<org.xmpp.packet.Presence>	LocalMUCRoom.addOutcast(org.xmpp.packet.JID jid, String reason, MUCRole senderRole)
List<org.xmpp.packet.Presence>	LocalMUCRoom.addOwner(org.xmpp.packet.JID jid, MUCRole sendRole)
List<org.xmpp.packet.Presence>	LocalMUCRoom.addOwners(List<org.xmpp.packet.JID> newOwners, MUCRole senderRole)
org.xmpp.packet.Presence	LocalMUCRoom.addParticipant(org.xmpp.packet.JID jid, String reason, MUCRole senderRole)
org.xmpp.packet.Presence	LocalMUCRoom.addVisitor(org.xmpp.packet.JID jid, MUCRole senderRole)
void	LocalMUCRoom.changeSubject(org.xmpp.packet.Message packet, MUCRole role)
void	IQAdminHandler.handleIQ(org.xmpp.packet.IQ packet, MUCRole role) Handles the IQ packet sent by an owner or admin of the room.
void	IQOwnerHandler.handleIQ(org.xmpp.packet.IQ packet, MUCRole role) Handles the IQ packet sent by an owner of the room.
void	LocalMUCRoom.leaveRoom(MUCRole leaveRole)
void	LocalMUCRoom.lock(MUCRole senderRole)
void	LocalMUCRoom.nicknameChanged(MUCRole occupantRole, org.xmpp.packet.Presence newPresence, String oldNick, String newNick)
void	LocalMUCRoom.presenceUpdated(MUCRole occupantRole, org.xmpp.packet.Presence newPresence) Handles occupants updating their presence in the chatroom.
void	LocalMUCRoom.sendInvitation(org.xmpp.packet.JID to, String reason, MUCRole senderRole, List<org.dom4j.Element> extensions)
void	LocalMUCRoom.sendPrivatePacket(org.xmpp.packet.Packet packet, MUCRole senderRole)
void	LocalMUCRoom.sendPublicMessage(org.xmpp.packet.Message message, MUCRole senderRole)
void	LocalMUCRoom.unlock(MUCRole senderRole)