vanitasvitae/Smack
1
0
Fork 0
mirror of https://github.com/vanitasvitae/Smack.git synced 2024-11-26 22:12:05 +01:00
Code Issues Releases Wiki Activity

Add note about getMultiUserChat in MUC's javadoc

Browse source
This commit is contained in:
Florian Schmaus 2015-01-19 08:38:11 +01:00
parent f42d697d7c
commit 6bf9498904
1 changed files with 5 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

7
smack-extensions/src/main/java/org/jivesoftware/smackx/muc/MultiUserChat.java
View file

@ -71,15 +71,18 @@ import org.jivesoftware.smackx.xdata.FormField;
import org.jivesoftware.smackx.xdata.packet.DataForm; import org.jivesoftware.smackx.xdata.packet.DataForm;
/** /**
* A MultiUserChat room (XEP-45), created with {@link MultiUserChatManager#getMultiUserChat(String)}.
* <p>
* A MultiUserChat is a conversation that takes place among many users in a virtual * A MultiUserChat is a conversation that takes place among many users in a virtual
* room. A room could have many occupants with different affiliation and roles. * room. A room could have many occupants with different affiliation and roles.
* Possible affiliations are "owner", "admin", "member", and "outcast". Possible roles * Possible affiliations are "owner", "admin", "member", and "outcast". Possible roles
* are "moderator", "participant", and "visitor". Each role and affiliation guarantees * are "moderator", "participant", and "visitor". Each role and affiliation guarantees
* different privileges (e.g. Send messages to all occupants, Kick participants and visitors, * different privileges (e.g. Send messages to all occupants, Kick participants and visitors,
* Grant voice, Edit member list, etc.). * Grant voice, Edit member list, etc.).
* </p>
* <p> * <p>
* <b>Note:</b> Make sure to leave the MUC ({@link #leave()}) before you drop the reference to * <b>Note:</b> Make sure to leave the MUC ({@link #leave()}) when you don't need it anymore or
* it, or otherwise you may leak the instance. * otherwise you may leak the instance.
* </p> * </p>
* *
* @author Gaston Dombiak, Larry Kirschner * @author Gaston Dombiak, Larry Kirschner