Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric6.Helpviewer.VirusTotalApi.html
Documentation/Source/eric6.Helpviewer.VirusTotalApi.html
- changeset 3673
- e26d7d0c1088
- child 4335
- a25c157625c4
equal
deleted
inserted
replaced
| 3670:f0cb7579c0b4 | 3673:e26d7d0c1088 |
|---|---|
| 1 <!DOCTYPE html> | |
| 2 <html><head> | |
| 3 <title>eric6.Helpviewer.VirusTotalApi</title> | |
| 4 <meta charset="UTF-8"> | |
| 5 <style> | |
| 6 body { | |
| 7 background: #EDECE6; | |
| 8 margin: 0em 1em 10em 1em; | |
| 9 color: black; | |
| 10 } | |
| 11 | |
| 12 h1 { color: white; background: #85774A; } | |
| 13 h2 { color: white; background: #85774A; } | |
| 14 h3 { color: white; background: #9D936E; } | |
| 15 h4 { color: white; background: #9D936E; } | |
| 16 | |
| 17 a { color: #BA6D36; } | |
| 18 | |
| 19 </style> | |
| 20 </head> | |
| 21 <body><a NAME="top" ID="top"></a> | |
| 22 <h1>eric6.Helpviewer.VirusTotalApi</h1> | |
| 23 <p> | |
| 24 Module implementing the <a href="http://www.virustotal.com">VirusTotal</a> | |
| 25 API class. | |
| 26 </p> | |
| 27 <h3>Global Attributes</h3> | |
| 28 <table> | |
| 29 <tr><td>None</td></tr> | |
| 30 </table> | |
| 31 <h3>Classes</h3> | |
| 32 <table> | |
| 33 <tr> | |
| 34 <td><a href="#VirusTotalAPI">VirusTotalAPI</a></td> | |
| 35 <td>Class implementing the <a href="http://www.virustotal.com">VirusTotal</a> API.</td> | |
| 36 </tr> | |
| 37 </table> | |
| 38 <h3>Functions</h3> | |
| 39 <table> | |
| 40 <tr><td>None</td></tr> | |
| 41 </table> | |
| 42 <hr /><hr /> | |
| 43 <a NAME="VirusTotalAPI" ID="VirusTotalAPI"></a> | |
| 44 <h2>VirusTotalAPI</h2> | |
| 45 <p> | |
| 46 Class implementing the <a href="http://www.virustotal.com">VirusTotal</a> | |
| 47 API. | |
| 48 </p><h3>Signals</h3> | |
| 49 <dl> | |
| 50 <dt>checkServiceKeyFinished(bool, str)</dt> | |
| 51 <dd> | |
| 52 emitted after the service key | |
| 53 check has been performed. It gives a flag indicating validity | |
| 54 (boolean) and an error message in case of a network error (string). | |
| 55 </dd><dt>fileScanReport(str)</dt> | |
| 56 <dd> | |
| 57 emitted with the URL of the file scan report | |
| 58 page | |
| 59 </dd><dt>submitUrlError(str)</dt> | |
| 60 <dd> | |
| 61 emitted with the error string, if the URL scan | |
| 62 submission returned an error. | |
| 63 </dd><dt>urlScanReport(str)</dt> | |
| 64 <dd> | |
| 65 emitted with the URL of the URL scan report page | |
| 66 </dd> | |
| 67 </dl> | |
| 68 <h3>Derived from</h3> | |
| 69 QObject | |
| 70 <h3>Class Attributes</h3> | |
| 71 <table> | |
| 72 <tr><td>GetFileReportPattern</td></tr><tr><td>GetUrlReportPattern</td></tr><tr><td>ReportFileScanPagePattern</td></tr><tr><td>ReportUrlScanPagePattern</td></tr><tr><td>ScanUrlPattern</td></tr><tr><td>SearchUrl</td></tr><tr><td>ServiceResult_InvalidServiceKey</td></tr><tr><td>ServiceResult_ItemNotPresent</td></tr><tr><td>ServiceResult_ItemPresent</td></tr><tr><td>ServiceResult_RequestLimitReached</td></tr><tr><td>TestServiceKeyScanID</td></tr> | |
| 73 </table> | |
| 74 <h3>Class Methods</h3> | |
| 75 <table> | |
| 76 <tr> | |
| 77 <td><a href="#VirusTotalAPI.getSearchRequestData">getSearchRequestData</a></td> | |
| 78 <td>Class method to assemble the search request data structure.</td> | |
| 79 </tr> | |
| 80 </table> | |
| 81 <h3>Methods</h3> | |
| 82 <table> | |
| 83 <tr> | |
| 84 <td><a href="#VirusTotalAPI.__init__">VirusTotalAPI</a></td> | |
| 85 <td>Constructor</td> | |
| 86 </tr><tr> | |
| 87 <td><a href="#VirusTotalAPI.__checkServiceKeyValidityFinished">__checkServiceKeyValidityFinished</a></td> | |
| 88 <td>Private slot to determine the result of the service key validity check.</td> | |
| 89 </tr><tr> | |
| 90 <td><a href="#VirusTotalAPI.__getFileScanReportUrl">__getFileScanReportUrl</a></td> | |
| 91 <td>Private method to get the report URL for a file scan.</td> | |
| 92 </tr><tr> | |
| 93 <td><a href="#VirusTotalAPI.__getFileScanReportUrlFinished">__getFileScanReportUrlFinished</a></td> | |
| 94 <td>Private slot to determine the result of the file scan report URL request.</td> | |
| 95 </tr><tr> | |
| 96 <td><a href="#VirusTotalAPI.__loadSettings">__loadSettings</a></td> | |
| 97 <td>Private method to load the settings.</td> | |
| 98 </tr><tr> | |
| 99 <td><a href="#VirusTotalAPI.__submitUrlFinished">__submitUrlFinished</a></td> | |
| 100 <td>Private slot to determine the result of the URL scan submission.</td> | |
| 101 </tr><tr> | |
| 102 <td><a href="#VirusTotalAPI.checkServiceKeyValidity">checkServiceKeyValidity</a></td> | |
| 103 <td>Public method to check the validity of the given service key.</td> | |
| 104 </tr><tr> | |
| 105 <td><a href="#VirusTotalAPI.preferencesChanged">preferencesChanged</a></td> | |
| 106 <td>Public slot to handle a change of preferences.</td> | |
| 107 </tr><tr> | |
| 108 <td><a href="#VirusTotalAPI.submitUrl">submitUrl</a></td> | |
| 109 <td>Public method to submit an URL to be scanned.</td> | |
| 110 </tr> | |
| 111 </table> | |
| 112 <h3>Static Methods</h3> | |
| 113 <table> | |
| 114 <tr><td>None</td></tr> | |
| 115 </table> | |
| 116 <a NAME="VirusTotalAPI.getSearchRequestData" ID="VirusTotalAPI.getSearchRequestData"></a> | |
| 117 <h4>VirusTotalAPI.getSearchRequestData (class method)</h4> | |
| 118 <b>getSearchRequestData</b>(<i>term</i>) | |
| 119 <p> | |
| 120 Class method to assemble the search request data structure. | |
| 121 </p><dl> | |
| 122 <dt><i>term</i></dt> | |
| 123 <dd> | |
| 124 search term (string) | |
| 125 </dd> | |
| 126 </dl><dl> | |
| 127 <dt>Returns:</dt> | |
| 128 <dd> | |
| 129 tuple of network request object, operation and parameters | |
| 130 (QNetworkRequest, QNetworkAccessManager.Operation, QByteArray) | |
| 131 </dd> | |
| 132 </dl><a NAME="VirusTotalAPI.__init__" ID="VirusTotalAPI.__init__"></a> | |
| 133 <h4>VirusTotalAPI (Constructor)</h4> | |
| 134 <b>VirusTotalAPI</b>(<i>parent=None</i>) | |
| 135 <p> | |
| 136 Constructor | |
| 137 </p><dl> | |
| 138 <dt><i>parent</i></dt> | |
| 139 <dd> | |
| 140 reference to the parent object (QObject) | |
| 141 </dd> | |
| 142 </dl><a NAME="VirusTotalAPI.__checkServiceKeyValidityFinished" ID="VirusTotalAPI.__checkServiceKeyValidityFinished"></a> | |
| 143 <h4>VirusTotalAPI.__checkServiceKeyValidityFinished</h4> | |
| 144 <b>__checkServiceKeyValidityFinished</b>(<i></i>) | |
| 145 <p> | |
| 146 Private slot to determine the result of the service key validity check. | |
| 147 </p><a NAME="VirusTotalAPI.__getFileScanReportUrl" ID="VirusTotalAPI.__getFileScanReportUrl"></a> | |
| 148 <h4>VirusTotalAPI.__getFileScanReportUrl</h4> | |
| 149 <b>__getFileScanReportUrl</b>(<i>scanId</i>) | |
| 150 <p> | |
| 151 Private method to get the report URL for a file scan. | |
| 152 </p><dl> | |
| 153 <dt><i>scanId</i></dt> | |
| 154 <dd> | |
| 155 ID of the scan to get the report URL for (string) | |
| 156 </dd> | |
| 157 </dl><a NAME="VirusTotalAPI.__getFileScanReportUrlFinished" ID="VirusTotalAPI.__getFileScanReportUrlFinished"></a> | |
| 158 <h4>VirusTotalAPI.__getFileScanReportUrlFinished</h4> | |
| 159 <b>__getFileScanReportUrlFinished</b>(<i></i>) | |
| 160 <p> | |
| 161 Private slot to determine the result of the file scan report URL | |
| 162 request. | |
| 163 </p><a NAME="VirusTotalAPI.__loadSettings" ID="VirusTotalAPI.__loadSettings"></a> | |
| 164 <h4>VirusTotalAPI.__loadSettings</h4> | |
| 165 <b>__loadSettings</b>(<i></i>) | |
| 166 <p> | |
| 167 Private method to load the settings. | |
| 168 </p><a NAME="VirusTotalAPI.__submitUrlFinished" ID="VirusTotalAPI.__submitUrlFinished"></a> | |
| 169 <h4>VirusTotalAPI.__submitUrlFinished</h4> | |
| 170 <b>__submitUrlFinished</b>(<i></i>) | |
| 171 <p> | |
| 172 Private slot to determine the result of the URL scan submission. | |
| 173 </p><a NAME="VirusTotalAPI.checkServiceKeyValidity" ID="VirusTotalAPI.checkServiceKeyValidity"></a> | |
| 174 <h4>VirusTotalAPI.checkServiceKeyValidity</h4> | |
| 175 <b>checkServiceKeyValidity</b>(<i>key, protocol=""</i>) | |
| 176 <p> | |
| 177 Public method to check the validity of the given service key. | |
| 178 </p><dl> | |
| 179 <dt><i>key</i></dt> | |
| 180 <dd> | |
| 181 service key (string) | |
| 182 </dd><dt><i>protocol</i></dt> | |
| 183 <dd> | |
| 184 protocol used to access VirusTotal (string) | |
| 185 </dd> | |
| 186 </dl><a NAME="VirusTotalAPI.preferencesChanged" ID="VirusTotalAPI.preferencesChanged"></a> | |
| 187 <h4>VirusTotalAPI.preferencesChanged</h4> | |
| 188 <b>preferencesChanged</b>(<i></i>) | |
| 189 <p> | |
| 190 Public slot to handle a change of preferences. | |
| 191 </p><a NAME="VirusTotalAPI.submitUrl" ID="VirusTotalAPI.submitUrl"></a> | |
| 192 <h4>VirusTotalAPI.submitUrl</h4> | |
| 193 <b>submitUrl</b>(<i>url</i>) | |
| 194 <p> | |
| 195 Public method to submit an URL to be scanned. | |
| 196 </p><dl> | |
| 197 <dt><i>url</i></dt> | |
| 198 <dd> | |
| 199 url to be scanned (QUrl) | |
| 200 </dd> | |
| 201 </dl> | |
| 202 <div align="right"><a href="#top">Up</a></div> | |
| 203 <hr /> | |
| 204 </body></html> |
