com.aol.acc
Class AccSecondarySession

java.lang.Object
  extended by com.aol.acc.AccBase
      extended by com.aol.acc.AccSecondarySession
Direct Known Subclasses:
AccAvSession, AccCustomSession, AccFileSharingSession, AccFileXferSession, AccImSession, AccShareBuddiesSession

public class AccSecondarySession
extends AccBase

IAccSecondarySession is an abstract class for secondary (Rendezvous) sessions.
Interfaces such as IAccImSession, IAccAvSession, etc. inherit from this interface.


Method Summary
 void accept()
          Accept this session proposed by another user.

 void cancelProposal(java.lang.String invitee)
          Withdraw a proposal you sent.
 int eject(java.lang.String userName, java.lang.String reason)
          Eject the specified user from the session, for the specified reason.
"reason" may not be supported in all session types.
 void endSession()
          End the current session.

 java.util.Date getCreationTime()
          The creation time of the SecondarySession
 java.lang.String getInvitation()
          The invitation associated with the secondary session
 java.lang.String[] getInvitees()
          The currently pending invitees to the secondary session
 AccSecondarySession[] getLinkedSessions()
          DEPRECATED
 int getMaxParticipantCount()
          The maximum number of participants in the secondary session
 java.lang.String getName()
          The name, if any, for the secondary session
 int getOnlineTime()
          The online time of the secondary session, in seconds
 AccParticipant[] getParticipants()
          The list of participants in the secondary session
 int getRemainingTime()
          The time remaining before this secondary session ends, in seconds
 java.lang.String getRemoteUserName()
          The remote user name, if any, of the secondary session
 boolean getSecure()
          Whether this secondary session is secure
 AccSecondarySessionServiceId getServiceId()
          Get the service id of the session.

 AccSession getSession()
          The IAccSession associated with the SecondarySession
 AccSecondarySessionState getSessionState()
          Alias for AccSecondarySessionProp_State
 AccSecondarySessionState getState()
          The state of the secondary session
 int invite(java.lang.String invitee, java.lang.String invitation)
          Invite a user to the session, changing the session type if needed.
The result is communicated asynchronously via
DAccEvents::OnInviteResult.

 void reject(AccResult reason)
          Reject this session proposed by another user.
"reason" should be an ACC_E_ HRESULT, or omitted.

 void setLinkedSessions(AccSecondarySession[] LinkedSessions)
          DEPRECATED
 
Methods inherited from class com.aol.acc.AccBase
compareHandle, equals
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Method Detail

getServiceId

public AccSecondarySessionServiceId getServiceId()
                                          throws AccException
Get the service id of the session.

Throws:
AccException

accept

public void accept()
            throws AccException
Accept this session proposed by another user.

Throws:
AccException

reject

public void reject(AccResult reason)
            throws AccException
Reject this session proposed by another user.
"reason" should be an ACC_E_ HRESULT, or omitted.

Throws:
AccException

invite

public int invite(java.lang.String invitee,
                  java.lang.String invitation)
           throws AccException
Invite a user to the session, changing the session type if needed.
The result is communicated asynchronously via
DAccEvents::OnInviteResult.

Throws:
AccException

cancelProposal

public void cancelProposal(java.lang.String invitee)
                    throws AccException
Withdraw a proposal you sent. For multi-party sessions, if an
invitee is not specified, all outgoing proposals for the session
are canceled. For peer-to-peer sessions, invitee is ignored.

Throws:
AccException

eject

public int eject(java.lang.String userName,
                 java.lang.String reason)
          throws AccException
Eject the specified user from the session, for the specified reason.
"reason" may not be supported in all session types. The result is
communicated asynchronously via DAccEvents::OnEjectResult.

Throws:
AccException

endSession

public void endSession()
                throws AccException
End the current session.

Throws:
AccException

getSession

public AccSession getSession()
                      throws AccException
The IAccSession associated with the SecondarySession

Throws:
AccException

getState

public AccSecondarySessionState getState()
                                  throws AccException
The state of the secondary session

Throws:
AccException

getSessionState

public AccSecondarySessionState getSessionState()
                                         throws AccException
Alias for AccSecondarySessionProp_State

Throws:
AccException

getInvitation

public java.lang.String getInvitation()
                               throws AccException
The invitation associated with the secondary session

Throws:
AccException

getSecure

public boolean getSecure()
                  throws AccException
Whether this secondary session is secure

Throws:
AccException

getRemoteUserName

public java.lang.String getRemoteUserName()
                                   throws AccException
The remote user name, if any, of the secondary session

Throws:
AccException

getParticipants

public AccParticipant[] getParticipants()
                                 throws AccException
The list of participants in the secondary session

Throws:
AccException

getMaxParticipantCount

public int getMaxParticipantCount()
                           throws AccException
The maximum number of participants in the secondary session

Throws:
AccException

getInvitees

public java.lang.String[] getInvitees()
                               throws AccException
The currently pending invitees to the secondary session

Throws:
AccException

getName

public java.lang.String getName()
                         throws AccException
The name, if any, for the secondary session

Throws:
AccException

getCreationTime

public java.util.Date getCreationTime()
                               throws AccException
The creation time of the SecondarySession

Throws:
AccException

getOnlineTime

public int getOnlineTime()
                  throws AccException
The online time of the secondary session, in seconds

Throws:
AccException

getRemainingTime

public int getRemainingTime()
                     throws AccException
The time remaining before this secondary session ends, in seconds

Throws:
AccException

getLinkedSessions

public AccSecondarySession[] getLinkedSessions()
                                        throws AccException
DEPRECATED

Throws:
AccException

setLinkedSessions

public void setLinkedSessions(AccSecondarySession[] LinkedSessions)
                       throws AccException
DEPRECATED

Throws:
AccException