** Also affects: ubuntu-download-manager (Ubuntu)
   Importance: Undecided
       Status: New

** Changed in: ubuntu-download-manager
       Status: Triaged => Fix Released

** Changed in: ubuntu-download-manager (Ubuntu)
       Status: New => Fix Released

-- 
You received this bug notification because you are a member of Ubuntu
Touch seeded packages, which is subscribed to ubuntu-download-manager in
Ubuntu.
https://bugs.launchpad.net/bugs/1451878

Title:
  Signals of SingleDownload and DownloadManagers are not documented

Status in ubuntu-download-manager:
  Fix Released
Status in ubuntu-download-manager package in Ubuntu:
  Fix Released

Bug description:
  In order to fully understand and use the DownloadManager and
  SingleDownload APIs, it is important to document the signals as well:

  import QtQuick.tooling 1.1  
    
  // This file describes the plugin-supplied types contained in the library.  
  // It is used for QML tooling purposes only.  
  //  
  // This file was auto-generated by:  
  // 'qmlplugindump Ubuntu.DownloadManager 0.1'  
    
  Module {  
      Component {  
          name: "Ubuntu::DownloadManager::DownloadError"  
          prototype: "QObject"  
          exports: ["Error 0.1"]  
          exportMetaObjectRevisions: [0]  
          Property { name: "type"; type: "string"; isReadonly: true }  
          Property { name: "message"; type: "string"; isReadonly: true }  
      }  
      Component {  
          name: "Ubuntu::DownloadManager::Metadata"  
          prototype: "QObject"  
          exports: ["Metadata 0.1"]  
          exportMetaObjectRevisions: [0]  
          Property { name: "title"; type: "string" }  
          Property { name: "showInIndicator"; type: "bool" }  
          Property { name: "deflate"; type: "bool" }  
          Property { name: "extract"; type: "bool" }  
          Signal { name: "showIndicatorChanged" }  
      }  
      Component {  
          name: "Ubuntu::DownloadManager::SingleDownload"  
          prototype: "QObject"  
          exports: ["SingleDownload 0.1"]  
          exportMetaObjectRevisions: [0]  
          Property { name: "autoStart"; type: "bool" }  
          Property { name: "errorMessage"; type: "string"; isReadonly: true }  
          Property { name: "isCompleted"; type: "bool"; isReadonly: true }  
          Property { name: "downloadInProgress"; type: "bool"; isReadonly: true 
}  
          Property { name: "allowMobileDownload"; type: "bool" }  
          Property { name: "throttle"; type: "qulonglong" }  
          Property { name: "progress"; type: "int"; isReadonly: true }  
          Property { name: "downloading"; type: "bool"; isReadonly: true }  
          Property { name: "downloadId"; type: "string"; isReadonly: true }  
          Property { name: "headers"; type: "QVariantMap" }  
          Property { name: "metadata"; type: 
"Ubuntu::DownloadManager::Metadata"; isPointer: true }  
          Signal {  
              name: "canceled"  
              Parameter { name: "success"; type: "bool" }  
          }  
          Signal {  
              name: "finished"  
              Parameter { name: "path"; type: "string" }  
          }  
          Signal {  
              name: "paused"  
              Parameter { name: "success"; type: "bool" }  
          }  
          Signal {  
              name: "processing"  
              Parameter { name: "path"; type: "string" }  
          }  
          Signal {  
              name: "progressReceived"  
              Parameter { name: "received"; type: "qulonglong" }  
              Parameter { name: "total"; type: "qulonglong" }  
          }  
          Signal {  
              name: "resumed"  
              Parameter { name: "success"; type: "bool" }  
          }  
          Signal {  
              name: "started"  
              Parameter { name: "success"; type: "bool" }  
          }  
          Signal {  
              name: "errorFound"  
              Parameter { name: "error"; type: "DownloadError&" }  
          }  
          Signal { name: "errorChanged" }  
          Method {  
              name: "registerError"  
              Parameter { name: "error"; type: "Error"; isPointer: true }  
          }  
          Method {  
              name: "bindDownload"  
              Parameter { name: "download"; type: "Download"; isPointer: true } 
 
          }  
          Method {  
              name: "unbindDownload"  
              Parameter { name: "download"; type: "Download"; isPointer: true } 
 
          }  
          Method {  
              name: "onFinished"  
              Parameter { name: "path"; type: "string" }  
          }  
          Method {  
              name: "onProgress"  
              Parameter { name: "received"; type: "qulonglong" }  
              Parameter { name: "total"; type: "qulonglong" }  
          }  
          Method {  
              name: "onPaused"  
              Parameter { name: "wasPaused"; type: "bool" }  
          }  
          Method {  
              name: "onResumed"  
              Parameter { name: "wasResumed"; type: "bool" }  
          }  
          Method {  
              name: "onStarted"  
              Parameter { name: "wasStarted"; type: "bool" }  
          }  
          Method {  
              name: "onCanceled"  
              Parameter { name: "wasCanceled"; type: "bool" }  
          }  
          Method { name: "start" }  
          Method { name: "pause" }  
          Method { name: "resume" }  
          Method { name: "cancel" }  
          Method {  
              name: "download"  
              Parameter { name: "url"; type: "string" }  
          }  
      }  
      Component {  
          name: "Ubuntu::DownloadManager::UbuntuDownloadManager"  
          prototype: "QObject"  
          exports: ["DownloadManager 0.1"]  
          exportMetaObjectRevisions: [0]  
          Property { name: "autoStart"; type: "bool" }  
          Property { name: "cleanDownloads"; type: "bool" }  
          Property { name: "errorMessage"; type: "string"; isReadonly: true }  
          Property { name: "downloads"; type: "QVariantList"; isReadonly: true 
}  
          Signal { name: "errorChanged" }  
          Method {  
              name: "download"  
              Parameter { name: "url"; type: "string" }  
          }  
      }  
  }  

  For example, "finished" signal is important to get hold of the path of
  the downloaded file.

  Best regards,
  XiaoGuo

To manage notifications about this bug go to:
https://bugs.launchpad.net/ubuntu-download-manager/+bug/1451878/+subscriptions

-- 
Mailing list: https://launchpad.net/~touch-packages
Post to     : touch-packages@lists.launchpad.net
Unsubscribe : https://launchpad.net/~touch-packages
More help   : https://help.launchpad.net/ListHelp

Reply via email to