Jive Forums API (5.5.20.2-oracle) Developer Javadocs

com.jivesoftware.webchat.chat
Class ChatSession

java.lang.Object
  extended by com.jivesoftware.webchat.chat.ChatSession
All Implemented Interfaces:
org.jivesoftware.smackx.MessageEventNotificationListener

public class ChatSession
extends java.lang.Object
implements org.jivesoftware.smackx.MessageEventNotificationListener


Constructor Summary
ChatSession()
           
 
Method Summary
 void cancelledNotification(java.lang.String from, java.lang.String packetID)
           
 void close()
           
 void composingNotification(java.lang.String from, java.lang.String packetID)
          Since only the agent app broadcasts this type of notification, we don't need to worry about who specifically this notification is from
 boolean composingNotificationsWereReceived()
          Returns whether composing notifications were received; regardless, the flag describing this condition is set to false after this query.
 void deliveredNotification(java.lang.String from, java.lang.String packetID)
          MessageEventNotificationListener implementation
 void displayedNotification(java.lang.String from, java.lang.String packetID)
           
 org.jivesoftware.smack.Chat getChat()
           
 ChatPoller getChatPoller()
           
 org.jivesoftware.smack.XMPPConnection getConnection()
          Returns the current connection
 org.jivesoftware.smackx.MessageEventManager getMessageEventManager()
           
 java.lang.String getNickname()
           
 java.lang.String getParticipant()
           
 boolean isAuthenticated()
          Returns true if the user has logged in anonymous or with a username and password.
 boolean isClosed()
           
 boolean isInChat()
           
 void offlineNotification(java.lang.String from, java.lang.String packetID)
           
 void processPacket(org.jivesoftware.smack.packet.Packet packet)
           
 void setNickname(java.lang.String nickname)
           
 void setupListeners()
          InvitationListener implementation
 void startSession(java.lang.String participant, java.lang.String roomName, java.lang.String chatID)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ChatSession

public ChatSession()
Method Detail

startSession

public void startSession(java.lang.String participant,
                         java.lang.String roomName,
                         java.lang.String chatID)

getConnection

public org.jivesoftware.smack.XMPPConnection getConnection()
Returns the current connection


isAuthenticated

public boolean isAuthenticated()
Returns true if the user has logged in anonymous or with a username and password.

Returns:
true if the user has logged in.

isInChat

public boolean isInChat()

getChat

public org.jivesoftware.smack.Chat getChat()

isClosed

public boolean isClosed()

composingNotificationsWereReceived

public boolean composingNotificationsWereReceived()
Returns whether composing notifications were received; regardless, the flag describing this condition is set to false after this query.


close

public void close()

setupListeners

public void setupListeners()
InvitationListener implementation


deliveredNotification

public void deliveredNotification(java.lang.String from,
                                  java.lang.String packetID)
MessageEventNotificationListener implementation

Specified by:
deliveredNotification in interface org.jivesoftware.smackx.MessageEventNotificationListener

displayedNotification

public void displayedNotification(java.lang.String from,
                                  java.lang.String packetID)
Specified by:
displayedNotification in interface org.jivesoftware.smackx.MessageEventNotificationListener

composingNotification

public void composingNotification(java.lang.String from,
                                  java.lang.String packetID)
Since only the agent app broadcasts this type of notification, we don't need to worry about who specifically this notification is from

Specified by:
composingNotification in interface org.jivesoftware.smackx.MessageEventNotificationListener

offlineNotification

public void offlineNotification(java.lang.String from,
                                java.lang.String packetID)
Specified by:
offlineNotification in interface org.jivesoftware.smackx.MessageEventNotificationListener

cancelledNotification

public void cancelledNotification(java.lang.String from,
                                  java.lang.String packetID)
Specified by:
cancelledNotification in interface org.jivesoftware.smackx.MessageEventNotificationListener

processPacket

public void processPacket(org.jivesoftware.smack.packet.Packet packet)

getMessageEventManager

public org.jivesoftware.smackx.MessageEventManager getMessageEventManager()

setNickname

public void setNickname(java.lang.String nickname)

getNickname

public java.lang.String getNickname()

getChatPoller

public ChatPoller getChatPoller()

getParticipant

public java.lang.String getParticipant()

Jive Forums Project Page

Copyright © 1999-2006 Jive Software.