Uses of Class
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.spi	Implementation of Multi-User Chat (XEP-0045).

Uses of MUCRole in org.jivesoftware.openfire.muc

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

Modifier and Type	Field	Description
ArrayList<MUCRole>	MUCRoom.occupants	All occupants that are associated with this room.

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

Modifier and Type	Method	Description
static MUCRole	MUCRole.createRoomRole(MUCRoom room)	Deprecated, for removal: This API element is subject to removal in a future version. Replaced by createRoomSelfRepresentation(MUCRoom)
static MUCRole	MUCRole.createRoomSelfRepresentation(MUCRoom room)	An empty instance that represents the room itself in the chatroom.
MUCRole	MUCRoom.getOccupantByFullJID(org.xmpp.packet.JID jid)	Returns the occupant data of a given user in the room by his full JID or null if no occupant data was found for the specified user.
MUCRole	MUCRoom.getRole()	Deprecated, for removal: This API element is subject to removal in a future version. Replaced by MUCRoom.getSelfRepresentation()
MUCRole	MUCRoom.getSelfRepresentation()	Obtain the occupant data representing the chat service itself (mainly for addressing messages and presence).
MUCRole	MUCRoom.joinRoom(String nickname, String password, HistoryRequest historyRequest, org.xmpp.packet.JID realAddress, 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	Description
Collection<MUCRole>	MUCRoom.getModerators()	Returns a collection with the current list of room moderators.
default Collection<MUCRole>	MultiUserChatService.getMUCRoles(org.xmpp.packet.JID user)	Deprecated, for removal: This API element is subject to removal in a future version. Replaced by MultiUserChatService.getOccupants(JID)
Collection<MUCRole>	MUCRoom.getOccupants()	Obtain the roles of all users in the chatroom.
Collection<MUCRole>	MultiUserChatService.getOccupants(org.xmpp.packet.JID user)	Returns the list of MUCRole in all rooms for the specified user's session.
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	Description
List<org.xmpp.packet.Presence>	MUCRoom.addAdmin(org.xmpp.packet.JID jid, MUCRole actor)	Adds a new user to the list of admins.
List<org.xmpp.packet.Presence>	MUCRoom.addAdmins(List<org.xmpp.packet.JID> newAdmins, MUCRole actor)	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 actor)	Adds a new user to the list of members.
org.xmpp.packet.Presence	MUCRoom.addModerator(org.xmpp.packet.JID jid, MUCRole actor)	Changes the role of the user within the room to moderator.
List<org.xmpp.packet.Presence>	MUCRoom.addNone(org.xmpp.packet.JID jid, MUCRole actor)	Removes the user from all the other affiliation list thus giving the user a NONE affiliation.
void	MUCRoom.addOccupant(MUCRole occupant)	Adds an occupant to all the internal occupants collections.
void	MUCRoom.addOccupantRole(MUCRole occupant)	Deprecated, for removal: This API element is subject to removal in a future version. Replaced by MUCRoom.addOccupant(MUCRole)
List<org.xmpp.packet.Presence>	MUCRoom.addOutcast(org.xmpp.packet.JID jid, String reason, MUCRole actor)	Adds a new user to the list of outcast users.
List<org.xmpp.packet.Presence>	MUCRoom.addOwner(org.xmpp.packet.JID jid, MUCRole actor)	Adds a new user to the list of owners.
List<org.xmpp.packet.Presence>	MUCRoom.addOwners(List<org.xmpp.packet.JID> newOwners, MUCRole actor)	Adds a list of users to the list of owners.
org.xmpp.packet.Presence	MUCRoom.addParticipant(org.xmpp.packet.JID jid, String reason, MUCRole actor)	Changes the role of the user within the room to participant.
void	MUCRoom.addRealJidToMessage(org.xmpp.packet.Message message, MUCRole sender)	Based on XEP-0045, section 7.2.13: If the room is non-anonymous, the service MAY include an Extended Stanza Addressing (XEP-0033) [16] element that notes the original full JID of the sender by means of the "ofrom" address type
org.xmpp.packet.Presence	MUCRoom.addVisitor(org.xmpp.packet.JID jid, MUCRole actor)	Changes the role of the user within the room to visitor.
void	MUCRoom.changeSubject(org.xmpp.packet.Message packet, MUCRole actor)	Changes the room's subject if the occupant has enough permissions.
void	MUCRoom.leaveRoom(MUCRole leavingOccupant)	Remove a member from the chat room.
void	MUCRoom.lock(MUCRole actor)	Locks the room so that users cannot join the room.
void	MUCRoom.nicknameChanged(MUCRole occupant, 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 occupant, org.xmpp.packet.Presence newPresence)	An event callback fired whenever an occupant updated his presence in the chatroom.
void	MUCRoom.removeOccupant(MUCRole occupant)	Removes the occupant from all the internal occupants collections.
void	MUCRoom.removeOccupantRole(MUCRole occupant)	Deprecated, for removal: This API element is subject to removal in a future version. replaced by MUCRoom.removeOccupant(MUCRole)
void	MUCRoom.send(org.xmpp.packet.Packet packet, MUCRole sender)	Sends a packet to the occupants of the room.
void	HistoryRequest.sendHistory(MUCRole occupant, MUCRoomHistory roomHistory)	Sends the smallest amount of traffic that meets any combination of the requested criteria.
CompletableFuture<Void>	MUCRoom.sendInitialPresenceToExistingOccupants(MUCRole joinedOccupant)	Sends presence of new occupant to existing occupants.
void	MUCRoom.sendInvitation(org.xmpp.packet.JID to, String reason, MUCRole sender, List<org.dom4j.Element> extensions)	Sends an invitation to a user.
CompletableFuture<Void>	MUCRoom.sendLeavePresenceToExistingOccupants(MUCRole leavingOccupant)	Sends presence of a leaving occupant to applicable occupants of the room that is being left.
void	MUCRoom.sendPrivatePacket(org.xmpp.packet.Packet packet, MUCRole sender)	Sends a private packet to a selected occupant.
void	MUCRoom.sendPublicMessage(org.xmpp.packet.Message message, MUCRole sender)	Sends a message to the all the occupants.
void	MUCRoom.unlock(MUCRole actor)	Unlocks the room so that users can join the room.

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

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

Modifier and Type	Method	Description
Collection<MUCRole>	MultiUserChatServiceImpl.getOccupants(org.xmpp.packet.JID user)

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

Modifier and Type	Method	Description
CompletableFuture<?>	FMUCHandler.OutboundJoinProgress.addToQueue(org.xmpp.packet.Packet stanza, MUCRole sender)	Adds a stanza to be sent to the remote, joined MUC as soon as federation has been established.
void	IQAdminHandler.handleIQ(org.xmpp.packet.IQ packet, MUCRole sender)	Handles the IQ packet sent by an owner or admin of the room.
void	IQOwnerHandler.handleIQ(org.xmpp.packet.IQ packet, MUCRole sender)	Handles the IQ packet sent by an owner of the room.
Future<?>	FMUCHandler.join(MUCRole occupantData)	Makes a user in our XMPP domain join the FMUC room.
protected Future<?>	FMUCHandler.join(MUCRole occupantData, boolean includeInbound, boolean includeOutbound)
CompletableFuture<?>	FMUCHandler.propagate(org.xmpp.packet.Packet stanza, MUCRole sender)	Propagates a stanza to the FMUC set, if FMUC is active for this room.
boolean	FMUCHandler.OutboundJoin.wantsStanzasSentBy(MUCRole sender)