net.kano.joscar.rv
Class NewRvSessionEvent

java.lang.Object
  extended byNewRvSessionEvent

public class NewRvSessionEvent
extends java.lang.Object

An event that occurs when a new rendezvous session is created. Note that an event of this type occurs even if a new session is created manually via a RvProcessor's createNewSession method. See getSessionType documentation for details.


Field Summary
static java.lang.Object TYPE_INCOMING
          An event type indicating that a rendezvous session was created "remotely," via an RV command with a new rendezvous session ID being received.
static java.lang.Object TYPE_OUTGOING
          An event type indicating that a rendezvous session was created locally before sending an initial RV request on that session to another user.
 
Constructor Summary
protected NewRvSessionEvent(RvProcessor rvProcessor, RvSession newSession, java.lang.Object sessionType)
          Creates a new new-rendezvous-session event with the given properties.
 
Method Summary
 RvProcessor getRvProcessor()
          Returns the RV processor on which the associated RV session was created.
 RvSession getSession()
          Returns the session that was created.
 java.lang.Object getSessionType()
          Returns the session creation event type.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

TYPE_INCOMING

public static final java.lang.Object TYPE_INCOMING
An event type indicating that a rendezvous session was created "remotely," via an RV command with a new rendezvous session ID being received. In practice, this means an initial rendezvous request was received, such as a request inviting the user to a chat room.


TYPE_OUTGOING

public static final java.lang.Object TYPE_OUTGOING
An event type indicating that a rendezvous session was created locally before sending an initial RV request on that session to another user. In practice, this means RvProcessor.createRvSession(java.lang.String) was called.

See Also:
RvProcessor.createRvSession(java.lang.String)
Constructor Detail

NewRvSessionEvent

protected NewRvSessionEvent(RvProcessor rvProcessor,
                            RvSession newSession,
                            java.lang.Object sessionType)
Creates a new new-rendezvous-session event with the given properties.

Parameters:
rvProcessor - the RV processor on which the given session was created
newSession - the session that was created
sessionType - the event type, like TYPE_INCOMING
Method Detail

getRvProcessor

public final RvProcessor getRvProcessor()
Returns the RV processor on which the associated RV session was created.

Returns:
the RV processor on which the associated session was created

getSession

public final RvSession getSession()
Returns the session that was created.

Returns:
the session that was created

getSessionType

public final java.lang.Object getSessionType()
Returns the session creation event type. Will be one of TYPE_INCOMING and TYPE_OUTGOING.

Returns:
the new session's "session type"