From 93adc6aec9ba4671884d9692308b239d3064e553 Mon Sep 17 00:00:00 2001 From: Manjeet Dahiya Date: Sat, 21 Aug 2010 19:15:30 +0000 Subject: add doc html --- doc/html/classQXmppTransferManager.html | 335 ++++++++++++++++++++++++++++++++ 1 file changed, 335 insertions(+) create mode 100644 doc/html/classQXmppTransferManager.html (limited to 'doc/html/classQXmppTransferManager.html') diff --git a/doc/html/classQXmppTransferManager.html b/doc/html/classQXmppTransferManager.html new file mode 100644 index 00000000..c8b7d190 --- /dev/null +++ b/doc/html/classQXmppTransferManager.html @@ -0,0 +1,335 @@ + + + + + +QXmpp: QXmppTransferManager Class Reference + + + + + + + + + +
+

QXmppTransferManager Class Reference
+ +[Managers] +

+

The QXmppTransferManager class provides support for sending and receiving files. +More...

+ +

#include <QXmppTransferManager.h>

+ +

List of all members.

+ + + + + + + + + + + + + + + + +

Signals

void fileReceived (QXmppTransferJob *offer)
void finished (QXmppTransferJob *job)
+void logMessage (QXmppLogger::MessageType type, const QString &msg)
 This signal is emitted to send logging messages.

Public Member Functions

+ QXmppTransferManager (QXmppStream *stream, QObject *parent=0)
QXmppTransferJob * sendFile (const QString &jid, const QString &fileName, const QString &sid=QString())
QXmppTransferJob * sendFile (const QString &jid, QIODevice *device, const QXmppTransferFileInfo &fileInfo, const QString &sid=QString())
QString proxy () const
void setProxy (const QString &proxyJid)
bool proxyOnly () const
void setProxyOnly (bool proxyOnly)
QXmppTransferJob::Methods supportedMethods () const
void setSupportedMethods (QXmppTransferJob::Methods methods)
+

Detailed Description

+

The QXmppTransferManager class provides support for sending and receiving files.

+

Stream initiation is performed as described in XEP-0095: Stream Initiation and XEP-0096: SI File Transfer. The actual file transfer is then performed using either XEP-0065: SOCKS5 Bytestreams or XEP-0047: In-Band Bytestreams.

+

Member Function Documentation

+ +
+
+ + + + + + + + + +
void QXmppTransferManager::fileReceived (QXmppTransferJob *  offer )  [signal]
+
+
+

This signal is emitted when a new file transfer offer is received.

+

To accept the transfer job, call the job's QXmppTransferJob::accept() method. To refuse the transfer job, call the job's QXmppTransferJob::abort() method.

+ +
+
+ +
+
+ + + + + + + + + +
void QXmppTransferManager::finished (QXmppTransferJob *  job )  [signal]
+
+
+

This signal is emitted whenever a transfer job is finished.

+
See also:
QXmppTransferJob::finished()
+ +
+
+ +
+
+ + + + + + + + +
QString QXmppTransferManager::proxy ( )  const
+
+
+

Return the JID of the bytestream proxy to use for outgoing transfers.

+ +
+
+ +
+
+ + + + + + + + +
bool QXmppTransferManager::proxyOnly ( )  const
+
+
+

Return whether the proxy will systematically be used for outgoing SOCKS5 bytestream transfers.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
QXmppTransferJob * QXmppTransferManager::sendFile (const QString &  jid,
QIODevice *  device,
const QXmppTransferFileInfo &  fileInfo,
const QString &  sid = QString() 
)
+
+
+

Send file to a remote party.

+

The remote party will be given the choice to accept or refuse the transfer.

+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
QXmppTransferJob * QXmppTransferManager::sendFile (const QString &  jid,
const QString &  fileName,
const QString &  sid = QString() 
)
+
+
+

Send file to a remote party.

+

The remote party will be given the choice to accept or refuse the transfer.

+ +
+
+ +
+
+ + + + + + + + + +
void QXmppTransferManager::setProxy (const QString &  proxyJid ) 
+
+
+

Set the JID of the SOCKS5 bytestream proxy to use for outgoing transfers.

+

If you set a proxy, when you send a file the proxy will be offered to the recipient in addition to your own IP addresses.

+ +
+
+ +
+
+ + + + + + + + + +
void QXmppTransferManager::setProxyOnly (bool  proxyOnly ) 
+
+
+

Set whether the proxy should systematically be used for outgoing SOCKS5 bytestream transfers.

+
Note:
If you set this to true and do not provide a proxy using setProxy(), your outgoing transfers will fail!
+ +
+
+ +
+
+ + + + + + + + + +
void QXmppTransferManager::setSupportedMethods (QXmppTransferJob::Methods  methods ) 
+
+
+

Set the supported stream methods. This allows you to selectively enable or disable stream methods (In-Band or SOCKS5 bytestreams).

+

The methods argument is a combination of zero or more QXmppTransferJob::Method.

+ +
+
+ +
+
+ + + + + + + + +
QXmppTransferJob::Methods QXmppTransferManager::supportedMethods ( )  const
+
+
+

Return the supported stream methods.

+

The methods are a combination of zero or more QXmppTransferJob::Method.

+ +
+
+
The documentation for this class was generated from the following files: +
+ +
+ All Classes Functions Enumerations Enumerator
+ + +
+ +
+ +
Generated on Sun Aug 22 00:44:24 2010 for QXmpp by  + +doxygen 1.6.1
+ + -- cgit v1.2.3