diff options
| author | Alex Blasche <alexander.blasche@digia.com> | 2014-10-13 11:20:24 +0200 |
|---|---|---|
| committer | Alex Blasche <alexander.blasche@digia.com> | 2014-10-16 09:49:11 +0200 |
| commit | 8b42497996549bccbbaabdf35756e1b8f2e6642b (patch) | |
| tree | 21231c8fcb63a287fc4d7e529a3c7f82798d9797 /src/bluetooth/qbluetoothtransfermanager.cpp | |
| parent | 4accb03289285610928199e9ab50ea2620d5e3d8 (diff) | |
Improve QBluetoothTransferManager documentation
Change-Id: I918bd3b4134504d5bfc3e160adeb97187186df3d
Reviewed-by: Timur Pocheptsov <Timur.Pocheptsov@digia.com>
Reviewed-by: Leena Miettinen <riitta-leena.miettinen@digia.com>
Reviewed-by: Mitch Curtis <mitch.curtis@digia.com>
Diffstat (limited to 'src/bluetooth/qbluetoothtransfermanager.cpp')
| -rw-r--r-- | src/bluetooth/qbluetoothtransfermanager.cpp | 14 |
1 files changed, 12 insertions, 2 deletions
diff --git a/src/bluetooth/qbluetoothtransfermanager.cpp b/src/bluetooth/qbluetoothtransfermanager.cpp index 0754fb9a..56e59f48 100644 --- a/src/bluetooth/qbluetoothtransfermanager.cpp +++ b/src/bluetooth/qbluetoothtransfermanager.cpp @@ -51,7 +51,10 @@ QT_BEGIN_NAMESPACE \since 5.2 - QBluetoothTransferManager uses OBEX to send put commands to remote devices. + QBluetoothTransferManager uses OBEX to send put commands to remote devices. A typical + OBEX transfer is initialized as follows: + + \snippet doc_src_qtbluetooth.cpp sendfile Note that this API is not currently supported on Android. */ @@ -60,7 +63,14 @@ QT_BEGIN_NAMESPACE \fn QBluetoothTransferReply *QBluetoothTransferManager::put(const QBluetoothTransferRequest &request, QIODevice *data) Sends the contents of \a data to the remote device identified by \a request, and returns a new - QBluetoothTransferReply that can be used to track the request's progress. + QBluetoothTransferReply that can be used to track the request's progress. \a data must remain valid + until the \l finished() signal is emitted. + + The returned \l QBluetoothTransferReply object must be immediately checked for its + \l {QBluetoothTransferReply::error()}{error()} state. This is required in case + this function detects an error during the initialization of the + \l QBluetoothTransferReply. In such cases \l {QBluetoothTransferReply::isFinished()} returns + \c true as well. If the platform does not support the Object Push profile, this function will return \c 0. */ |