Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
T
transfer-engine
Project overview
Project overview
Details
Activity
Releases
Cycle Analytics
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Charts
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Charts
Create a new issue
Commits
Issue Boards
Open sidebar
mer-core
transfer-engine
Commits
b63f5b49
Commit
b63f5b49
authored
Nov 28, 2017
by
Pekka Vuorela
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Fix some qdoc warnings
\o deprecated in favor of \li, \returns doesn't exist.
parent
662184a5
Changes
7
Hide whitespace changes
Inline
Side-by-side
Showing
7 changed files
with
61 additions
and
61 deletions
+61
-61
doc/src/index.qdoc
doc/src/index.qdoc
+7
-7
doc/src/mediaplugininterface.qdoc
doc/src/mediaplugininterface.qdoc
+3
-3
lib/imageoperation.cpp
lib/imageoperation.cpp
+3
-3
lib/mediatransferinterface.cpp
lib/mediatransferinterface.cpp
+4
-4
lib/transferengineclient.cpp
lib/transferengineclient.cpp
+12
-12
src/dbmanager.cpp
src/dbmanager.cpp
+10
-10
src/transferengine.cpp
src/transferengine.cpp
+22
-22
No files found.
doc/src/index.qdoc
View file @
b63f5b49
...
...
@@ -63,10 +63,10 @@ share functionality implementation depends on the client e.g. if it's HW specifi
such as Facebook. Each plugin must implement or use the following interface:
\list
\
o
\l {TransferPluginInterface} Share plugin must implement this interface
\
o
\l {MediaTransferInterface} Share plugin must implement this interface
\
o
\l {TransferPluginInfo} Share plugin must provide information about plugin using this class
\
o
\l {TransferMethodInfo} Share plugin must provide information about e.g. accounts using this class
\
li
\l {TransferPluginInterface} Share plugin must implement this interface
\
li
\l {MediaTransferInterface} Share plugin must implement this interface
\
li
\l {TransferPluginInfo} Share plugin must provide information about plugin using this class
\
li
\l {TransferMethodInfo} Share plugin must provide information about e.g. accounts using this class
\endlist
\section3 Client API
...
...
@@ -77,14 +77,14 @@ example Transfer UI and client side sharing interface on top of it. The Transfer
be used by clients who want to inform Nemo Transfer Engine of ongoing Sync or Downloads.
\list
\
o
DBus API - see org.nemomobile.transferengine.xml. For the client side it will generate TransferEngineInterface
\
li
DBus API - see org.nemomobile.transferengine.xml. For the client side it will generate TransferEngineInterface
class which can be used directly.
\
o
TransferEngineClient - The convenience API to create Sync and Download events.
\
li
TransferEngineClient - The convenience API to create Sync and Download events.
\endlist
\section3 Reference
\list
\
o
\l {Nemo Transfer Engine Reference}
\
li
\l {Nemo Transfer Engine Reference}
\endlist
*/
doc/src/mediaplugininterface.qdoc
View file @
b63f5b49
...
...
@@ -41,9 +41,9 @@
TransferEngine supports C++ share plugins. Each share plugin must implement couple of well defined interfaces:
\list
\
o
\l TransferPluginInterface Provides interfaces to access required objects to start sharing.
\
o
\l MediaTransferInterface Implements the actual sharing functionality
\
o
\l TransferPluginInfo Provides information about plugin status such as is it ready.
\
li
\l TransferPluginInterface Provides interfaces to access required objects to start sharing.
\
li
\l MediaTransferInterface Implements the actual sharing functionality
\
li
\l TransferPluginInfo Provides information about plugin status such as is it ready.
\endlist
TransferPluginInterface provides information to the TransferEngine via this interface.
...
...
lib/imageoperation.cpp
View file @
b63f5b49
...
...
@@ -38,9 +38,9 @@
This class is meant to be used by share plugins. It can be used for:
\list
\
o
Removing image metadata
\
o
Scaling image
\
o
Create a temp files from the image paths
\
li
Removing image metadata
\
li
Scaling image
\
li
Create a temp files from the image paths
\endlist
*/
...
...
lib/mediatransferinterface.cpp
View file @
b63f5b49
...
...
@@ -60,10 +60,10 @@ public:
each share plugin. The subclass of this class is resposible of providing:
\list
\
o
Status information of the sharing
\
o
Progress of the sharing
\
o
Information, if cancel and restart actions are supported
\
o
Starting and/or canceling the sharing
\
li
Status information of the sharing
\
li
Progress of the sharing
\
li
Information, if cancel and restart actions are supported
\
li
Starting and/or canceling the sharing
\endlist
...
...
lib/transferengineclient.cpp
View file @
b63f5b49
...
...
@@ -78,11 +78,11 @@ CallbackInterface::CallbackInterface()
Construct CallbackInterface instance to provide callback information to the TransferEngineClient. Setup
arguments as:
\list
\
o
\a server e.g. "com.jolla.myapp"
\
o
\a path e.g. "/com/jolla/myapp"
\
o
\a interface e.g. "com.jolla.myapp"
\
o
\a cancelMethod Cancel method name e.g. "cancelSync"
\
o
\a restartMethod Restart method name e.g. "restartSync"
\
li
\a server e.g. "com.jolla.myapp"
\
li
\a path e.g. "/com/jolla/myapp"
\
li
\a interface e.g. "com.jolla.myapp"
\
li
\a cancelMethod Cancel method name e.g. "cancelSync"
\
li
\a restartMethod Restart method name e.g. "restartSync"
\endlist
*/
CallbackInterface
::
CallbackInterface
(
const
QString
&
server
,
const
QString
&
path
,
const
QString
&
interface
,
...
...
@@ -222,9 +222,9 @@ TransferEngineClient::~TransferEngineClient()
Create a download event to the TransferEngine. This only creates and entry, and client
needs still call:
\list
\
o
\l TransferEngineClient::startTransfer()
\
o
\l TransferEngineClient::updateTransferProgress()
\
o
\l TransferEngineClient::finishTransfer()
\
li
\l TransferEngineClient::startTransfer()
\
li
\l TransferEngineClient::updateTransferProgress()
\
li
\l TransferEngineClient::finishTransfer()
\endlist
\sa createSyncEvent(), startTransfer(), updateTransferProgress(), finishTransfer()
...
...
@@ -325,9 +325,9 @@ void TransferEngineClient::updateTransferProgress(int transferId, qreal progress
Finalize the transfer with \a transferId. There are three options for finalizing the transfer by setting
the \a status parameter value:
\list
\
o
\l TransferEngineClient::TransferFinished - success
\
o
\l TransferEngineClient::TransferCanceled - user cancelation
\
o
\l TransferEngineClient::TransferInterrupted - an error
\
li
\l TransferEngineClient::TransferFinished - success
\
li
\l TransferEngineClient::TransferCanceled - user cancelation
\
li
\l TransferEngineClient::TransferInterrupted - an error
\endlist
If the client wants to provide reason for finishing the transfer, it's possible to provide \a reason
...
...
@@ -388,7 +388,7 @@ void TransferEngineClient::enableNotifications(bool enable)
/*!
Private method for QML interface.
\r
eturns true if notifications are enabled, otherwise false is returned.
R
eturns true if notifications are enabled, otherwise false is returned.
*/
bool
TransferEngineClient
::
notificationsEnabled
()
const
{
...
...
src/dbmanager.cpp
View file @
b63f5b49
...
...
@@ -277,11 +277,11 @@ DbManager::~DbManager()
In a case there is a DBus callback, then QStringList contains the following items:
\list
\
o
service
\
o
path
\
o
interface
\
o
cancel method name
\
o
restart method name
\
li
service
\
li
path
\
li
interface
\
li
cancel method name
\
li
restart method name
\endlist
*/
QStringList
DbManager
::
callback
(
int
key
)
const
...
...
@@ -349,11 +349,11 @@ int DbManager::createMetadataEntry(int key, const QString &title, const QString
The callback is a dbus interface so it must contain the following attributes:
\list
\
o
\a service e.g. com.jolla.myapp
\
o
\a path e.g. /com/jolla/myapp
\
o
\a interface e.g. com.jolla.myapp
\
o
\a cancelMethod The name of the cancel method
\
o
\a restartMethod The name of the restart method
\
li
\a service e.g. com.jolla.myapp
\
li
\a path e.g. /com/jolla/myapp
\
li
\a interface e.g. com.jolla.myapp
\
li
\a cancelMethod The name of the cancel method
\
li
\a restartMethod The name of the restart method
\endlist
This method returns a key of the created callback record in a callback table or -1 on
...
...
src/transferengine.cpp
View file @
b63f5b49
...
...
@@ -717,9 +717,9 @@ void TransferEnginePrivate::callbackCall(int transferId, CallbackMethodType meth
TransferEngine is the central place for:
\list
\
o
Sharing - Provides requires plugin interfaces for share plugins
\
o
Downloads - Provides an API to create Download entries
\
o
Syncs - Provides an API to create Sync entries
\
li
Sharing - Provides requires plugin interfaces for share plugins
\
li
Downloads - Provides an API to create Download entries
\
li
Syncs - Provides an API to create Sync entries
\endlist
For Downloads and Syncs, the Transfer Engine acts only a place to keep track of these operations.
...
...
@@ -827,10 +827,10 @@ TransferEngine::~TransferEngine()
TransferEngine handles the following user defined data automatically and stores them to the database:
\list
\
o
"title" Title for the media
\
o
"description" Description for the media
\
o
"accountId" The ID of the account which is used for sharing. See qt-accounts for more details.
\
o
"scalePercent" The scale percent e.g. downscale image to 50% from original before uploading.
\
li
"title" Title for the media
\
li
"description" Description for the media
\
li
"accountId" The ID of the account which is used for sharing. See qt-accounts for more details.
\
li
"scalePercent" The scale percent e.g. downscale image to 50% from original before uploading.
\endlist
In practice this method instantiates a share plugin with \a serviceId and passes a MediaItem instance filled
...
...
@@ -912,15 +912,15 @@ int TransferEngine::uploadMediaItemContent(const QVariantMap &content,
of type 'Download'.
\list
\
o
\a displayName The name for Download which may be used by the UI displaying the download
\
o
\a applicationIcon The application icon of the application created the download
\
o
\a serviceIcon The service icon, which provides the file to be downloaded
\
o
\a filePath The filePath e.g. url to the file to be downloaded
\
o
\a mimeType the MimeType of the file to be downloaded
\
o
\a expectedFileSize The file size of the file to be downloaded
\
o
\a callback QStringList containing DBus callback information such as: service, path and interface
\
o
\a cancelMethod The name of the cancel callback method, which DBus callback provides
\
o
\a restartMethod The name of the restart callback method, which DBus callback provides
\
li
\a displayName The name for Download which may be used by the UI displaying the download
\
li
\a applicationIcon The application icon of the application created the download
\
li
\a serviceIcon The service icon, which provides the file to be downloaded
\
li
\a filePath The filePath e.g. url to the file to be downloaded
\
li
\a mimeType the MimeType of the file to be downloaded
\
li
\a expectedFileSize The file size of the file to be downloaded
\
li
\a callback QStringList containing DBus callback information such as: service, path and interface
\
li
\a cancelMethod The name of the cancel callback method, which DBus callback provides
\
li
\a restartMethod The name of the restart callback method, which DBus callback provides
\endlist
This method returns the transfer id of the created Download transfer. Note that this method only
...
...
@@ -972,12 +972,12 @@ int TransferEngine::createDownload(const QString &displayName,
of type 'Download'.
\list
\
o
\a displayName The name for download which may be used by the UI displaying the download
\
o
\a applicationIcon The application icon of the application created the download
\
o
\a serviceIcon The service icon, which provides the file to be downloaded
\
o
\a callback QStringList containing DBus callback information such as: service, path and interface
\
o
\a cancelMethod The name of the cancel callback method, which DBus callback provides
\
o
\a restartMethod The name of the restart callback method, which DBus callback provides
\
li
\a displayName The name for download which may be used by the UI displaying the download
\
li
\a applicationIcon The application icon of the application created the download
\
li
\a serviceIcon The service icon, which provides the file to be downloaded
\
li
\a callback QStringList containing DBus callback information such as: service, path and interface
\
li
\a cancelMethod The name of the cancel callback method, which DBus callback provides
\
li
\a restartMethod The name of the restart callback method, which DBus callback provides
\endlist
This method returns the transfer id of the created Download transfer. Note that this method only
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment