Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.webchat.chat.group
Class GroupChats

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

public class GroupChats
extends java.lang.Object


Constructor Summary
GroupChats()
           
 
Method Summary
 boolean close(java.lang.String roomName, java.lang.String chatID)
           
 ChatInfo getInfoUpdate(java.lang.String roomName, java.lang.String chatID)
           
 ChatInfo getNewInformation(java.lang.String roomName, java.lang.String chatID)
           
 GroupChatSession getRoom(java.lang.String roomName, java.lang.String chatID)
           
 java.util.Map getRooms(java.lang.String chatID)
           
 boolean isConnected(java.lang.String roomName, java.lang.String chatID)
           
 void removeFromQueue(ChatMessage[] messages)
           
 ChatMessage sendMessage(java.lang.String roomName, java.lang.String chatID, java.lang.String message)
          Write a new message to the specified room.
 void setActivityTime(java.lang.String chatID)
           
 Information startSession(java.lang.String roomName, java.lang.String chatID, java.lang.String nickname)
          Starts a new GroupChat Session
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

GroupChats

public GroupChats()
Method Detail

startSession

public Information startSession(java.lang.String roomName,
                                java.lang.String chatID,
                                java.lang.String nickname)
Starts a new GroupChat Session

Parameters:
roomName - the name of the room to join.
chatID - the session id of the user.
nickname - the nickname to use in the room.
Returns:
the nickname if the user successfully joined, otherwise null if user was unable to join.

getInfoUpdate

public ChatInfo getInfoUpdate(java.lang.String roomName,
                              java.lang.String chatID)

removeFromQueue

public void removeFromQueue(ChatMessage[] messages)

sendMessage

public ChatMessage sendMessage(java.lang.String roomName,
                               java.lang.String chatID,
                               java.lang.String message)
Write a new message to the specified room.

Parameters:
roomName - the name of the room to write to.
message - the message to insert into the new room.

getRooms

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

getRoom

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

isConnected

public boolean isConnected(java.lang.String roomName,
                           java.lang.String chatID)

getNewInformation

public ChatInfo getNewInformation(java.lang.String roomName,
                                  java.lang.String chatID)

setActivityTime

public void setActivityTime(java.lang.String chatID)

close

public boolean close(java.lang.String roomName,
                     java.lang.String chatID)

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.