net.java.sip.communicator.service.protocol
Interface IncomingFileTransferRequest

All Known Implementing Classes:

IncomingFileTransferRequestIcqImpl, IncomingFileTransferRequestJabberImpl, IncomingFileTransferRequestMsnImpl, IncomingFileTransferRequestYahooImpl

public interface IncomingFileTransferRequest

Used for incoming file transfer request.

Author:

Nicolas Riegel, Yana Stamcheva

Method Summary

FileTransfer	acceptFile(File file) Function called to accept and receive the file.
String	getFileDescription() Returns a String that represents the description of the file that is being received.
String	getFileName() Returns a String that represents the name of the file that is being received.
long	getFileSize() Returns a long that represents the size of the file that is being received.
String	getID() Uniquie ID that is identifying the request and then the FileTransfer if the request has been accepted.
Contact	getSender() Returns a String that represents the name of the sender of the file being received.
byte[]	getThumbnail() Returns the thumbnail contained in this request.
void	rejectFile() Function called to refuse the file.

Method Detail

getID

String getID()

Uniquie ID that is identifying the request and then the FileTransfer if the request has been accepted.

Returns:

the id.

getFileName

String getFileName()

Returns a String that represents the name of the file that is being received. If there is no name, returns null.

Returns:

a String that represents the name of the file

getFileDescription

String getFileDescription()

Returns a String that represents the description of the file that is being received. If there is no description available, returns null.

Returns:

a String that represents the description of the file

getFileSize

long getFileSize()

Returns a long that represents the size of the file that is being received. If there is no file size available, returns null.

Returns:

a long that represents the size of the file

getSender

Contact getSender()

Returns a String that represents the name of the sender of the file being received. If there is no sender name available, returns null.

Returns:

a String that represents the name of the sender

acceptFile

FileTransfer acceptFile(File file)

Function called to accept and receive the file.

Parameters:

file - the file to accept

Returns:

the FileTransfer object managing the transfer

rejectFile

void rejectFile()

Function called to refuse the file.

getThumbnail

byte[] getThumbnail()

Returns the thumbnail contained in this request.

Returns:

the thumbnail contained in this request