LeechCraft Azoth  %{LEECHCRAFT_VERSION}
Modular multiprotocol IM plugin for LeechCraft
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator
LeechCraft::Azoth::ITransferManager Class Referenceabstract

This interface must be implemented by transfer managers returned from IAccount::GetTransferManager(). More...

#include "itransfermanager.h"

Public Member Functions

virtual ~ITransferManager ()
 
virtual QObject * SendFile (const QString &id, const QString &variant, const QString &name, const QString &comment)=0
 Requests a file transfer with the remote party. More...
 
virtual void fileOffered (QObject *job)=0
 Notifies about incoming transfer request. More...
 

Detailed Description

This interface must be implemented by transfer managers returned from IAccount::GetTransferManager().

Definition at line 191 of file itransfermanager.h.

Constructor & Destructor Documentation

virtual LeechCraft::Azoth::ITransferManager::~ITransferManager ( )
inlinevirtual

Definition at line 194 of file itransfermanager.h.

Member Function Documentation

virtual void LeechCraft::Azoth::ITransferManager::fileOffered ( QObject *  job)
pure virtual

Notifies about incoming transfer request.

This signal should be emitted by the transfer manager whenever another party issues a file transfer request.

The passed obj represents the transfer job, and it must implement the ITransferJob interface.

Ownership of the obj is transferred to the signal handler.

Note
This function is expected to be a signal.
Parameters
[out]jobThe transfer job, implementing ITransferJob.
virtual QObject* LeechCraft::Azoth::ITransferManager::SendFile ( const QString &  id,
const QString &  variant,
const QString &  name,
const QString &  comment 
)
pure virtual

Requests a file transfer with the remote party.

The entry is identified by the ID, which is the result of ICLEntry::GetEntryID().

If the variant is an empty string, or there is no such variant, the file should be transferred the the variant with the highest priority.

The returned object represents the file transfer request, and, further on, the file transfer job, should it be accepted. The returned object must implement ITransferJob. Ownership is transferred to the caller.

Parameters
[in]idThe id of the remote party, as ICLEntry::GetEntryID().
[in]variantThe entry variant to transfer with.
[in]nameThe path to the file that should be transferred.
Returns
The transfer job object representing this transfer and implement ITransferJob.

The documentation for this class was generated from the following file: