Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.webchat.chat.group
Class GroupChatUtils

java.lang.Object
  extended by com.jivesoftware.webchat.chat.group.GroupChatUtils

public class GroupChatUtils
extends java.lang.Object


Constructor Summary
GroupChatUtils()
           
 
Method Summary
 ChatPerson banUser(java.lang.String userNickname, java.lang.String roomName, java.lang.String sessionID)
           
 java.util.Collection getAllModerators(java.lang.String roomName, java.lang.String sessionID)
           
 java.util.Collection getAllUsersInRoom(java.lang.String roomName, java.lang.String sessionID)
           
 java.util.Collection getBannedUsers(java.lang.String roomName, java.lang.String sessionID)
           
 ChatPerson getPerson(java.lang.String nickname, java.lang.String roomName, java.lang.String sessionID)
           
 ChatPerson getPersonalInfo(java.lang.String roomName, java.lang.String sessionID)
           
 GroupChatSession getRoom(java.lang.String roomName, java.lang.String sessionID)
           
 java.util.Map getRooms(java.lang.String sessionID)
           
 java.lang.String getSubject(java.lang.String roomName, java.lang.String sessionID)
           
 ChatPerson kickUser(java.lang.String userNickname, java.lang.String roomName, java.lang.String sessionID)
           
 void setPageID(int pageID, java.lang.String roomName, java.lang.String sessionID)
           
 ChatPerson toggleBlock(java.lang.String nickname, java.lang.String roomName, java.lang.String sessionID)
           
 Information toggleModerator(java.lang.String nickname, java.lang.String roomName, java.lang.String sessionID)
           
 Information toggleVoice(java.lang.String nickname, java.lang.String roomName, java.lang.String sessionID)
           
 ChatPerson unbanUser(java.lang.String jid, java.lang.String roomName, java.lang.String sessionID)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GroupChatUtils

public GroupChatUtils()
Method Detail

toggleBlock

public ChatPerson toggleBlock(java.lang.String nickname,
                              java.lang.String roomName,
                              java.lang.String sessionID)

kickUser

public ChatPerson kickUser(java.lang.String userNickname,
                           java.lang.String roomName,
                           java.lang.String sessionID)

banUser

public ChatPerson banUser(java.lang.String userNickname,
                          java.lang.String roomName,
                          java.lang.String sessionID)

unbanUser

public ChatPerson unbanUser(java.lang.String jid,
                            java.lang.String roomName,
                            java.lang.String sessionID)

toggleModerator

public Information toggleModerator(java.lang.String nickname,
                                   java.lang.String roomName,
                                   java.lang.String sessionID)

toggleVoice

public Information toggleVoice(java.lang.String nickname,
                               java.lang.String roomName,
                               java.lang.String sessionID)

getPerson

public ChatPerson getPerson(java.lang.String nickname,
                            java.lang.String roomName,
                            java.lang.String sessionID)

getPersonalInfo

public ChatPerson getPersonalInfo(java.lang.String roomName,
                                  java.lang.String sessionID)

setPageID

public void setPageID(int pageID,
                      java.lang.String roomName,
                      java.lang.String sessionID)

getAllModerators

public java.util.Collection getAllModerators(java.lang.String roomName,
                                             java.lang.String sessionID)

getAllUsersInRoom

public java.util.Collection getAllUsersInRoom(java.lang.String roomName,
                                              java.lang.String sessionID)

getBannedUsers

public java.util.Collection getBannedUsers(java.lang.String roomName,
                                           java.lang.String sessionID)

getRooms

public java.util.Map getRooms(java.lang.String sessionID)

getRoom

public GroupChatSession getRoom(java.lang.String roomName,
                                java.lang.String sessionID)

getSubject

public java.lang.String getSubject(java.lang.String roomName,
                                   java.lang.String sessionID)

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.