|
Openfire 3.9.3 Javadoc | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.jivesoftware.openfire.muc.MUCEventDelegate
public abstract class MUCEventDelegate
Gives the implementer the ability to react to, allow, or deny MUC related events. For example: - Event: a user tries to join a room Reaction: the delegate decides to allow or deny the user from joining
Nested Class Summary | |
---|---|
static class |
MUCEventDelegate.InvitationResult
|
Constructor Summary | |
---|---|
MUCEventDelegate()
|
Method Summary | |
---|---|
abstract boolean |
destroyingRoom(String roomName,
org.xmpp.packet.JID userjid)
This event will be triggered when an entity attempts to destroy a room. |
abstract Map<String,String> |
getRoomConfig(String roomName)
Returns a map containing room configuration variables and values. |
abstract boolean |
joiningRoom(MUCRoom room,
org.xmpp.packet.JID userjid)
This event will be triggered when an entity joins an existing room. |
boolean |
loadConfig(MUCRoom room)
Loads a delegate provided room configuration for the room specified. |
abstract MUCEventDelegate.InvitationResult |
sendingInvitation(MUCRoom room,
org.xmpp.packet.JID inviteeJID,
org.xmpp.packet.JID inviterJID,
String inviteMessage)
This event will be triggered when an entity attempts to invite someone to a room. |
abstract boolean |
shouldRecreate(String roomName,
org.xmpp.packet.JID userjid)
Returns true if the room that is not present in the server should have existed and needs to be recreated. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public MUCEventDelegate()
Method Detail |
---|
public abstract boolean joiningRoom(MUCRoom room, org.xmpp.packet.JID userjid)
room
- the MUC room.userjid
- the JID of the user attempting to join the room.
public abstract MUCEventDelegate.InvitationResult sendingInvitation(MUCRoom room, org.xmpp.packet.JID inviteeJID, org.xmpp.packet.JID inviterJID, String inviteMessage)
room
- the MUC room.inviteeJID
- the JID of the user the invitation will be sent to.inviterJID
- the JID of the user that is sending the invitationinviteMessage
- the (optional) message that is sent explaining the invitation
public abstract Map<String,String> getRoomConfig(String roomName)
roomName
- the name of the room the configuration map is associated with.
public abstract boolean destroyingRoom(String roomName, org.xmpp.packet.JID userjid)
roomName
- the name of the MUC room being destroyed.userjid
- the JID of the user attempting to destroy the room.
public abstract boolean shouldRecreate(String roomName, org.xmpp.packet.JID userjid)
roomName
- name of the room.userjid
- JID Of the user trying to join/create the room.
public boolean loadConfig(MUCRoom room)
room
- the room to load the configuration for.
|
Openfire 3.9.3 Javadoc | ||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |