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

Javdoc improvements.

Browse source 
git-svn-id: http://svn.igniterealtime.org/svn/repos/smack/trunk@2099 b35dd754-fafc-0310-a699-88a17e54d16e
This commit is contained in:
Matt Tucker 2003-09-23 20:14:31 +00:00 committed by mtucker
parent 59ca4ec717
commit a48aaf73e8
2 changed files with 23 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

38
source/org/jivesoftware/smack/GroupChat.java
View file

@ -60,7 +60,7 @@ import org.jivesoftware.smack.filter.*;
import java.util.*; import java.util.*;
/** /**
* A GroupChat is a conversation that takes plaaces among many users in a virtual * A GroupChat is a conversation that takes place among many users in a virtual
* room. When joining a group chat, you specify a nickname, which is the identity * room. When joining a group chat, you specify a nickname, which is the identity
* that other chat room users see. * that other chat room users see.
* *
@ -81,11 +81,15 @@ public class GroupChat {
/** /**
* Creates a new group chat with the specified connection and room name. Note: no * Creates a new group chat with the specified connection and room name. Note: no
* information is sent to or received from the server until you attempt to join the * information is sent to or received from the server until you attempt to
* chat room. On some server implementations, the room will not be created until the * {@link #join(String) join} the chat room. On some server implementations,
* first person joins it. * the room will not be created until the first person joins it.<p>
* *
* @param connection the XMPP Connection. * Most XMPP servers use a sub-domain for the chat service (eg chat.example.com
* for the XMPP server example.com). You must ensure that the room address you're
* trying to connect to includes the proper chat sub-domain.
*
* @param connection the XMPP connection.
* @param room the name of the room in the form "roomName@service", where * @param room the name of the room in the form "roomName@service", where
* "service" is the hostname at which the multi-user chat * "service" is the hostname at which the multi-user chat
* service is running. * service is running.
@ -136,28 +140,20 @@ public class GroupChat {
} }
/** /**
* Joins the chat room using the specified nickname. If already joined as * Joins the chat room using the specified nickname. If already joined
* another nickname, will leave as that name first before joining under the new * using another nickname, this method will first leave the room and then
* name. The default timeout of 5 seconds for a reply from the group chat server * re-join using the new nickname. The default timeout of 5 seconds for a reply
* that the join succeeded will be used. * from the group chat server that the join succeeded will be used.
* *
* @param nickname the nicknam to use. * @param nickname the nickname to use.
* @throws XMPPException if an error occurs joining the room. * @throws XMPPException if an error occurs joining the room. In particular, a
* 409 error can occur if someone is already in the group chat with the same
* nickname.
*/ */
public synchronized void join(String nickname) throws XMPPException { public synchronized void join(String nickname) throws XMPPException {
join(nickname, 5000); join(nickname, 5000);
} }
/**
* Returns true if currently in the group chat (after calling the {@link
* #join(String)} method.
*
* @return true if currently in the group chat room.
*/
public boolean isJoined() {
return joined;
}
/** /**
* Joins the chat room using the specified nickname. If already joined as * Joins the chat room using the specified nickname. If already joined as
* another nickname, will leave as that name first before joining under the new * another nickname, will leave as that name first before joining under the new

8
source/org/jivesoftware/smack/XMPPConnection.java
View file

@ -462,9 +462,13 @@ public class XMPPConnection {
/** /**
* Creates a new group chat connected to the specified room. The room name * Creates a new group chat connected to the specified room. The room name
* should be a valid conference id, such as <tt>chatroom@jivesoftware.com</tt>. * should be full address, such as <tt>room@chat.example.com</tt>.
* <p>
* Most XMPP servers use a sub-domain for the chat service (eg chat.example.com
* for the XMPP server example.com). You must ensure that the room address you're
* trying to connect to includes the proper chat sub-domain.
* *
* @param room the name of the room. * @param room the fully qualifed name of the room.
* @return a new GroupChat object. * @return a new GroupChat object.
*/ */
public GroupChat createGroupChat(String room) { public GroupChat createGroupChat(String room) {