![]() |
LeechCraft Azoth
0.6.70-6645-gcd10d7e
Modular multiprotocol IM plugin for LeechCraft
|
This interface must be implemented by objects representing file transfer jobs. More...
#include "itransfermanager.h"
Public Member Functions | |
virtual | ~ITransferJob () |
virtual QString | GetSourceID () const =0 |
Returns the ID of the other party. More... | |
virtual QString | GetName () const =0 |
Returns the name of the file. More... | |
virtual qint64 | GetSize () const =0 |
Returns the size of the file. More... | |
virtual QString | GetComment () const =0 |
Returns the human-readable comment. More... | |
virtual TransferDirection | GetDirection () const =0 |
Returns the direction of the transfer. More... | |
virtual void | Accept (const QString &out)=0 |
Accepts an incoming transfer. More... | |
virtual void | Abort ()=0 |
Rejects or aborts a transfer. More... | |
Protected Member Functions | |
virtual void | transferProgress (qint64 done, qint64 total)=0 |
Notifies about transfer progress. More... | |
virtual void | errorAppeared (TransferError error, const QString &msg)=0 |
Notifies about error. More... | |
virtual void | stateChanged (TransferState state)=0 |
Notifies about state changes. More... | |
This interface must be implemented by objects representing file transfer jobs.
Definition at line 105 of file itransfermanager.h.
|
inlinevirtual |
Definition at line 108 of file itransfermanager.h.
References Abort(), Accept(), errorAppeared(), GetComment(), GetDirection(), GetName(), GetSize(), GetSourceID(), stateChanged(), and transferProgress().
|
pure virtual |
Rejects or aborts a transfer.
This method is used to reject an incoming file transfer request or abort an already accepted one that's in progress.
Referenced by ~ITransferJob().
|
pure virtual |
Accepts an incoming transfer.
This method only makes sense in incoming file transfers. It is used to accept the transfer and write the file the path given by the out parameter.
[in] | out | The file path to save the incoming data to. |
Referenced by ~ITransferJob().
|
protectedpure virtual |
Notifies about error.
[out] | error | The error condition. |
[out] | msg | The human-readable message describing the error. |
Referenced by ~ITransferJob().
|
pure virtual |
Returns the human-readable comment.
Referenced by ~ITransferJob().
|
pure virtual |
Returns the direction of the transfer.
Referenced by ~ITransferJob().
|
pure virtual |
Returns the name of the file.
Referenced by ~ITransferJob().
|
pure virtual |
Returns the size of the file.
Referenced by ~ITransferJob().
|
pure virtual |
Returns the ID of the other party.
The returned string should be compatible with the return value of ICLEntry::GetEntryID(), that is, it should be equal to that one of the corresponding ICLEntry.
Referenced by ~ITransferJob().
|
protectedpure virtual |
Notifies about state changes.
[out] | state | The new state of the transfer job. |
Referenced by ~ITransferJob().
|
protectedpure virtual |
Notifies about transfer progress.
[out] | done | The amount of data already transferred. |
[out] | total | The total amount of data. |
Referenced by ~ITransferJob().