|
Openfire 3.5.0.rc1 Javadoc | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface MUCRole
Defines the permissions and actions that a MUCUser may use in a particular room. Each MUCRole defines the relationship between a MUCRoom and a MUCUser.
MUCUsers can play different roles in different chatrooms.
Nested Class Summary | |
---|---|
static class |
MUCRole.Affiliation
|
static class |
MUCRole.Role
|
Method Summary | |
---|---|
void |
changeNickname(String nickname)
Changes the nickname of the occupant within the room to the new nickname. |
void |
destroy()
Destroys this role after the occupant left the room. |
MUCRole.Affiliation |
getAffiliation()
Obtain the affiliation state of the user. |
MUCRoom |
getChatRoom()
Obtain the chat room that hosts this user's role. |
String |
getNickname()
Obtain the nickname for the user in the chatroom. |
NodeID |
getNodeID()
Returns the id of the node that is hosting the room occupant. |
Presence |
getPresence()
Obtain the current presence status of a user in a chatroom. |
MUCRole.Role |
getRole()
Obtain the role state of the user. |
JID |
getRoleAddress()
Obtain the XMPPAddress representing this role in a room: room@server/nickname |
JID |
getUserAddress()
Obtain the XMPPAddress of the user that joined the room. |
boolean |
isLocal()
Returns true if this room occupant is hosted by this JVM. |
boolean |
isVoiceOnly()
Returns true if the room occupant does not want to get messages broadcasted to all room occupants. |
void |
send(Packet packet)
Sends a packet to the user. |
void |
setAffiliation(MUCRole.Affiliation newAffiliation)
Call this method to promote or demote a user's affiliation in a chatroom. |
void |
setPresence(Presence presence)
Set the current presence status of a user in a chatroom. |
void |
setRole(MUCRole.Role newRole)
Call this method to promote or demote a user's role in a chatroom. |
Method Detail |
---|
Presence getPresence()
void setPresence(Presence presence)
presence
- The presence of the user in the room.void setRole(MUCRole.Role newRole) throws NotAllowedException
Owning ChatUsers should have their membership roles updated.
newRole
- The new role that the user will play.
NotAllowedException
- Thrown if trying to change the moderator role to an owner or
administrator.MUCRole.Role getRole()
void setAffiliation(MUCRole.Affiliation newAffiliation) throws NotAllowedException
newAffiliation
- the new affiliation that the user will play.
NotAllowedException
- thrown if trying to ban an owner or an administrator.MUCRole.Affiliation getAffiliation()
void changeNickname(String nickname)
nickname
- the new nickname of the occupant in the room.String getNickname()
void destroy()
boolean isVoiceOnly()
To be a deaf occupant the initial presence sent to the room while joining the room has to include the following child element:
<x xmlns='http://jivesoftware.org/protocol/muc'> <deaf-occupant/> </x>Note that this is a custom extension to the MUC specification.
MUCRoom getChatRoom()
JID getRoleAddress()
JID getUserAddress()
boolean isLocal()
NodeID getNodeID()
void send(Packet packet)
packet
- The packet to send
|
Openfire 3.5.0.rc1 Javadoc | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |