Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric5.Helpviewer.VirusTotalApi.html
Documentation/Source/eric5.Helpviewer.VirusTotalApi.html
- changeset 978
- 11f8adbcac97
- child 979
- 0ae0c8852d31
equal
deleted
inserted
replaced
| 977:7a523bd4b00d | 978:11f8adbcac97 |
|---|---|
| 1 <?xml version="1.0" encoding="utf-8"?> | |
| 2 <!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN' | |
| 3 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'> | |
| 4 <html><head> | |
| 5 <title>eric5.Helpviewer.VirusTotalApi</title> | |
| 6 <style> | |
| 7 body { | |
| 8 background: #EDECE6; | |
| 9 margin: 0em 1em 10em 1em; | |
| 10 color: black; | |
| 11 } | |
| 12 | |
| 13 h1 { color: white; background: #85774A; } | |
| 14 h2 { color: white; background: #85774A; } | |
| 15 h3 { color: white; background: #9D936E; } | |
| 16 h4 { color: white; background: #9D936E; } | |
| 17 | |
| 18 a { color: #BA6D36; } | |
| 19 | |
| 20 </style> | |
| 21 </head> | |
| 22 <body><a NAME="top" ID="top"></a> | |
| 23 <h1>eric5.Helpviewer.VirusTotalApi</h1> | |
| 24 <p> | |
| 25 Module implementing the <a href="http://www.virustotal.com">VirusTotal</a> 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> API. | |
| 47 </p> | |
| 48 <h3>Derived from</h3> | |
| 49 QObject | |
| 50 <h3>Class Attributes</h3> | |
| 51 <table> | |
| 52 <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> | |
| 53 </table> | |
| 54 <h3>Methods</h3> | |
| 55 <table> | |
| 56 <tr> | |
| 57 <td><a href="#VirusTotalAPI.__init__">VirusTotalAPI</a></td> | |
| 58 <td>Constructor</td> | |
| 59 </tr><tr> | |
| 60 <td><a href="#VirusTotalAPI.__loadSettings">__loadSettings</a></td> | |
| 61 <td>Private method to load the settings.</td> | |
| 62 </tr><tr> | |
| 63 <td><a href="#VirusTotalAPI.checkServiceKeyValidity">checkServiceKeyValidity</a></td> | |
| 64 <td>Public method to check the validity of the given service key.</td> | |
| 65 </tr><tr> | |
| 66 <td><a href="#VirusTotalAPI.getFileScanReportUrl">getFileScanReportUrl</a></td> | |
| 67 <td>Public method to get the report URL for a file scan.</td> | |
| 68 </tr><tr> | |
| 69 <td><a href="#VirusTotalAPI.getSearchRequestData">getSearchRequestData</a></td> | |
| 70 <td></td> | |
| 71 </tr><tr> | |
| 72 <td><a href="#VirusTotalAPI.getUrlScanReportUrl">getUrlScanReportUrl</a></td> | |
| 73 <td>Public method to get the report URL for a URL scan.</td> | |
| 74 </tr><tr> | |
| 75 <td><a href="#VirusTotalAPI.submitUrl">submitUrl</a></td> | |
| 76 <td>Public method to submit an URL to be scanned.</td> | |
| 77 </tr> | |
| 78 </table> | |
| 79 <a NAME="VirusTotalAPI.__init__" ID="VirusTotalAPI.__init__"></a> | |
| 80 <h4>VirusTotalAPI (Constructor)</h4> | |
| 81 <b>VirusTotalAPI</b>(<i>parent=None</i>) | |
| 82 <p> | |
| 83 Constructor | |
| 84 </p><dl> | |
| 85 <dt><i>parent</i></dt> | |
| 86 <dd> | |
| 87 reference to the parent object (QObject) | |
| 88 </dd> | |
| 89 </dl><a NAME="VirusTotalAPI.__loadSettings" ID="VirusTotalAPI.__loadSettings"></a> | |
| 90 <h4>VirusTotalAPI.__loadSettings</h4> | |
| 91 <b>__loadSettings</b>(<i></i>) | |
| 92 <p> | |
| 93 Private method to load the settings. | |
| 94 </p><a NAME="VirusTotalAPI.checkServiceKeyValidity" ID="VirusTotalAPI.checkServiceKeyValidity"></a> | |
| 95 <h4>VirusTotalAPI.checkServiceKeyValidity</h4> | |
| 96 <b>checkServiceKeyValidity</b>(<i>key, protocol=""</i>) | |
| 97 <p> | |
| 98 Public method to check the validity of the given service key. | |
| 99 </p><dl> | |
| 100 <dt><i>key</i></dt> | |
| 101 <dd> | |
| 102 service key (string) | |
| 103 </dd><dt><i>protocol</i></dt> | |
| 104 <dd> | |
| 105 protocol used to access VirusTotal (string) | |
| 106 </dd> | |
| 107 </dl><dl> | |
| 108 <dt>Returns:</dt> | |
| 109 <dd> | |
| 110 flag indicating validity (boolean) and an error message in | |
| 111 case of a network error (string) | |
| 112 </dd> | |
| 113 </dl><a NAME="VirusTotalAPI.getFileScanReportUrl" ID="VirusTotalAPI.getFileScanReportUrl"></a> | |
| 114 <h4>VirusTotalAPI.getFileScanReportUrl</h4> | |
| 115 <b>getFileScanReportUrl</b>(<i>scanId</i>) | |
| 116 <p> | |
| 117 Public method to get the report URL for a file scan. | |
| 118 </p><dl> | |
| 119 <dt><i>scanId</i></dt> | |
| 120 <dd> | |
| 121 ID of the scan to get the report URL for (string) | |
| 122 </dd> | |
| 123 </dl><dl> | |
| 124 <dt>Returns:</dt> | |
| 125 <dd> | |
| 126 file scan report URL (string) | |
| 127 </dd> | |
| 128 </dl><a NAME="VirusTotalAPI.getSearchRequestData" ID="VirusTotalAPI.getSearchRequestData"></a> | |
| 129 <h4>VirusTotalAPI.getSearchRequestData</h4> | |
| 130 <b>getSearchRequestData</b>(<i>term</i>) | |
| 131 <p> | |
| 132 | |
| 133 </p><p> | |
| 134 | |
| 135 </p><a NAME="VirusTotalAPI.getUrlScanReportUrl" ID="VirusTotalAPI.getUrlScanReportUrl"></a> | |
| 136 <h4>VirusTotalAPI.getUrlScanReportUrl</h4> | |
| 137 <b>getUrlScanReportUrl</b>(<i>scanId</i>) | |
| 138 <p> | |
| 139 Public method to get the report URL for a URL scan. | |
| 140 </p><dl> | |
| 141 <dt><i>scanId</i></dt> | |
| 142 <dd> | |
| 143 ID of the scan to get the report URL for (string) | |
| 144 </dd> | |
| 145 </dl><dl> | |
| 146 <dt>Returns:</dt> | |
| 147 <dd> | |
| 148 URL scan report URL (string) | |
| 149 </dd> | |
| 150 </dl><a NAME="VirusTotalAPI.submitUrl" ID="VirusTotalAPI.submitUrl"></a> | |
| 151 <h4>VirusTotalAPI.submitUrl</h4> | |
| 152 <b>submitUrl</b>(<i>url</i>) | |
| 153 <p> | |
| 154 Public method to submit an URL to be scanned. | |
| 155 </p><dl> | |
| 156 <dt><i>url</i></dt> | |
| 157 <dd> | |
| 158 url to be scanned (QUrl) | |
| 159 </dd> | |
| 160 </dl><dl> | |
| 161 <dt>Returns:</dt> | |
| 162 <dd> | |
| 163 flag indicating success (boolean) and the scan ID (string) | |
| 164 </dd> | |
| 165 </dl> | |
| 166 <div align="right"><a href="#top">Up</a></div> | |
| 167 <hr /> | |
| 168 </body></html> |
