com.aol.acc
Class AccFileXferSession

java.lang.Object
  extended by com.aol.acc.AccBase
      extended by com.aol.acc.AccSecondarySession
          extended by com.aol.acc.AccFileXferSession

public class AccFileXferSession
extends AccSecondarySession

IAccFileXferSession is used for managing individual file/folder transfers.


Method Summary
 AccFileXfer getCurrentFileXfer()
          The current file being sent
 java.lang.String getDownloadDirPath()
          The download path for files to be transfered to
 AccFileXferSession getFileSharingSession()
          The file sharing session, if any
 boolean getIsDirectory()
          Whether this is a transfer of a file or directory
 java.lang.String getName()
          Name of the transfer, either the file or directory name
 boolean getSend()
          Whether this transfer is a send or a receive
 int getSpeed()
          Overall bytes per second of this session
 long getTotalBytes()
          Total bytes to be transferred for this session
 long getTotalBytesXferred()
          Total bytes transferred so far
 int getTotalNumFiles()
          Total number of files in the transfer
 int getTotalNumFilesRemaining()
          Number of files remaining to be transfered
 void resolveCollision(AccFileXferSessionCollisionAction action, java.lang.String path)
          Used to respond to DAccEvents::OnFileXferCollision.
 void setDownloadDirPath(java.lang.String DownloadDirPath)
          The download path for files to be transfered to
 void setName(java.lang.String Name)
          Name of the transfer, either the file or directory name
 
Methods inherited from class com.aol.acc.AccSecondarySession
accept, cancelProposal, eject, endSession, getCreationTime, getInvitation, getInvitees, getLinkedSessions, getMaxParticipantCount, getOnlineTime, getParticipants, getRemainingTime, getRemoteUserName, getSecure, getServiceId, getSession, getSessionState, getState, invite, reject, setLinkedSessions
 
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

resolveCollision

public void resolveCollision(AccFileXferSessionCollisionAction action,
                             java.lang.String path)
                      throws AccException
Used to respond to DAccEvents::OnFileXferCollision. The action specified by
"action" will be taken.

Throws:
AccException

getCurrentFileXfer

public AccFileXfer getCurrentFileXfer()
                               throws AccException
The current file being sent

Throws:
AccException

getDownloadDirPath

public java.lang.String getDownloadDirPath()
                                    throws AccException
The download path for files to be transfered to

Throws:
AccException

setDownloadDirPath

public void setDownloadDirPath(java.lang.String DownloadDirPath)
                        throws AccException
The download path for files to be transfered to

Throws:
AccException

getFileSharingSession

public AccFileXferSession getFileSharingSession()
                                         throws AccException
The file sharing session, if any

Throws:
AccException

getIsDirectory

public boolean getIsDirectory()
                       throws AccException
Whether this is a transfer of a file or directory

Throws:
AccException

getName

public java.lang.String getName()
                         throws AccException
Name of the transfer, either the file or directory name

Overrides:
getName in class AccSecondarySession
Throws:
AccException

setName

public void setName(java.lang.String Name)
             throws AccException
Name of the transfer, either the file or directory name

Throws:
AccException

getSend

public boolean getSend()
                throws AccException
Whether this transfer is a send or a receive

Throws:
AccException

getSpeed

public int getSpeed()
             throws AccException
Overall bytes per second of this session

Throws:
AccException

getTotalBytes

public long getTotalBytes()
                   throws AccException
Total bytes to be transferred for this session

Throws:
AccException

getTotalBytesXferred

public long getTotalBytesXferred()
                          throws AccException
Total bytes transferred so far

Throws:
AccException

getTotalNumFiles

public int getTotalNumFiles()
                     throws AccException
Total number of files in the transfer

Throws:
AccException

getTotalNumFilesRemaining

public int getTotalNumFilesRemaining()
                              throws AccException
Number of files remaining to be transfered

Throws:
AccException