Mercurial Repositories > eric / file comparison

comparison: src/eric7/Documentation/Source/eric7.WebBrowser.VirusTotal.VirusTotalApi.html

src/eric7/Documentation/Source/eric7.WebBrowser.VirusTotal.VirusTotalApi.html

branch
eric7
changeset 10479
856476537696
parent 10436
f6881d10e995
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.WebBrowser.VirusTotal.VirusTotalApi</h1> 9 <h1>eric7.WebBrowser.VirusTotal.VirusTotalApi</h1>
10
11 <p> 10 <p>
12 Module implementing the <a href="http://www.virustotal.com">VirusTotal</a> 11 Module implementing the <a href="http://www.virustotal.com">VirusTotal</a>
13 API class. 12 API class.
14 </p> 13 </p>
14
15 <h3>Global Attributes</h3> 15 <h3>Global Attributes</h3>
16
17 <table> 16 <table>
18 <tr><td>None</td></tr> 17 <tr><td>None</td></tr>
19 </table> 18 </table>
19
20 <h3>Classes</h3> 20 <h3>Classes</h3>
21 21 <table>
22 <table>
23
24 <tr> 22 <tr>
25 <td><a href="#VirusTotalAPI">VirusTotalAPI</a></td> 23 <td><a href="#VirusTotalAPI">VirusTotalAPI</a></td>
26 <td>Class implementing the <a href="http://www.virustotal.com">VirusTotal</a> API.</td> 24 <td>Class implementing the <a href="http://www.virustotal.com">VirusTotal</a> API.</td>
27 </tr> 25 </tr>
28 </table> 26 </table>
27
29 <h3>Functions</h3> 28 <h3>Functions</h3>
30
31 <table> 29 <table>
32 <tr><td>None</td></tr> 30 <tr><td>None</td></tr>
33 </table> 31 </table>
32
34 <hr /> 33 <hr />
35 <hr /> 34 <hr />
36 <a NAME="VirusTotalAPI" ID="VirusTotalAPI"></a> 35 <a NAME="VirusTotalAPI" ID="VirusTotalAPI"></a>
37 <h2>VirusTotalAPI</h2> 36 <h2>VirusTotalAPI</h2>
38
39 <p> 37 <p>
40 Class implementing the <a href="http://www.virustotal.com">VirusTotal</a> 38 Class implementing the <a href="http://www.virustotal.com">VirusTotal</a>
41 API. 39 API.
42 </p> 40 </p>
41
43 <h3>Signals</h3> 42 <h3>Signals</h3>
44 <dl> 43 <dl>
45 44
46 <dt>checkServiceKeyFinished(bool, str)</dt> 45 <dt>checkServiceKeyFinished(bool, str)</dt>
47 <dd> 46 <dd>
65 </dd> 64 </dd>
66 </dl> 65 </dl>
67 <h3>Derived from</h3> 66 <h3>Derived from</h3>
68 QObject 67 QObject
69 <h3>Class Attributes</h3> 68 <h3>Class Attributes</h3>
70 69 <table>
71 <table> 70 <tr><td>GetDomainReportPattern</td></tr>
72 <tr><td>GetDomainReportPattern</td></tr><tr><td>GetFileReportPattern</td></tr><tr><td>GetIpAddressReportPattern</td></tr><tr><td>GetUrlReportPattern</td></tr><tr><td>ScanUrlPattern</td></tr><tr><td>ServiceCode_InvalidKey</td></tr><tr><td>ServiceCode_InvalidPrivilege</td></tr><tr><td>ServiceCode_RateLimitExceeded</td></tr><tr><td>ServiceResult_ItemNotPresent</td></tr><tr><td>ServiceResult_ItemPresent</td></tr><tr><td>ServiceResult_ItemQueued</td></tr><tr><td>TestServiceKeyScanID</td></tr> 71 <tr><td>GetFileReportPattern</td></tr>
73 </table> 72 <tr><td>GetIpAddressReportPattern</td></tr>
73 <tr><td>GetUrlReportPattern</td></tr>
74 <tr><td>ScanUrlPattern</td></tr>
75 <tr><td>ServiceCode_InvalidKey</td></tr>
76 <tr><td>ServiceCode_InvalidPrivilege</td></tr>
77 <tr><td>ServiceCode_RateLimitExceeded</td></tr>
78 <tr><td>ServiceResult_ItemNotPresent</td></tr>
79 <tr><td>ServiceResult_ItemPresent</td></tr>
80 <tr><td>ServiceResult_ItemQueued</td></tr>
81 <tr><td>TestServiceKeyScanID</td></tr>
82 </table>
83
74 <h3>Class Methods</h3> 84 <h3>Class Methods</h3>
75
76 <table> 85 <table>
77 <tr><td>None</td></tr> 86 <tr><td>None</td></tr>
78 </table> 87 </table>
88
79 <h3>Methods</h3> 89 <h3>Methods</h3>
80 90 <table>
81 <table>
82
83 <tr> 91 <tr>
84 <td><a href="#VirusTotalAPI.__init__">VirusTotalAPI</a></td> 92 <td><a href="#VirusTotalAPI.__init__">VirusTotalAPI</a></td>
85 <td>Constructor</td> 93 <td>Constructor</td>
86 </tr> 94 </tr>
87 <tr> 95 <tr>
143 <tr> 151 <tr>
144 <td><a href="#VirusTotalAPI.submitUrl">submitUrl</a></td> 152 <td><a href="#VirusTotalAPI.submitUrl">submitUrl</a></td>
145 <td>Public method to submit an URL to be scanned.</td> 153 <td>Public method to submit an URL to be scanned.</td>
146 </tr> 154 </tr>
147 </table> 155 </table>
156
148 <h3>Static Methods</h3> 157 <h3>Static Methods</h3>
149
150 <table> 158 <table>
151 <tr><td>None</td></tr> 159 <tr><td>None</td></tr>
152 </table> 160 </table>
161
153 162
154 <a NAME="VirusTotalAPI.__init__" ID="VirusTotalAPI.__init__"></a> 163 <a NAME="VirusTotalAPI.__init__" ID="VirusTotalAPI.__init__"></a>
155 <h4>VirusTotalAPI (Constructor)</h4> 164 <h4>VirusTotalAPI (Constructor)</h4>
156 <b>VirusTotalAPI</b>(<i>parent=None</i>) 165 <b>VirusTotalAPI</b>(<i>parent=None</i>)
157
158 <p> 166 <p>
159 Constructor 167 Constructor
160 </p> 168 </p>
169
161 <dl> 170 <dl>
162 171
163 <dt><i>parent</i> (QObject)</dt> 172 <dt><i>parent</i> (QObject)</dt>
164 <dd> 173 <dd>
165 reference to the parent object 174 reference to the parent object
166 </dd> 175 </dd>
167 </dl> 176 </dl>
168 <a NAME="VirusTotalAPI.__checkServiceKeyValidityFinished" ID="VirusTotalAPI.__checkServiceKeyValidityFinished"></a> 177 <a NAME="VirusTotalAPI.__checkServiceKeyValidityFinished" ID="VirusTotalAPI.__checkServiceKeyValidityFinished"></a>
169 <h4>VirusTotalAPI.__checkServiceKeyValidityFinished</h4> 178 <h4>VirusTotalAPI.__checkServiceKeyValidityFinished</h4>
170 <b>__checkServiceKeyValidityFinished</b>(<i>reply</i>) 179 <b>__checkServiceKeyValidityFinished</b>(<i>reply</i>)
171
172 <p> 180 <p>
173 Private slot to determine the result of the service key validity check. 181 Private slot to determine the result of the service key validity check.
174 </p> 182 </p>
183
175 <dl> 184 <dl>
176 185
177 <dt><i>reply</i> (QNetworkReply)</dt> 186 <dt><i>reply</i> (QNetworkReply)</dt>
178 <dd> 187 <dd>
179 reference to the network reply 188 reference to the network reply
180 </dd> 189 </dd>
181 </dl> 190 </dl>
182 <a NAME="VirusTotalAPI.__getDomainReportFinished" ID="VirusTotalAPI.__getDomainReportFinished"></a> 191 <a NAME="VirusTotalAPI.__getDomainReportFinished" ID="VirusTotalAPI.__getDomainReportFinished"></a>
183 <h4>VirusTotalAPI.__getDomainReportFinished</h4> 192 <h4>VirusTotalAPI.__getDomainReportFinished</h4>
184 <b>__getDomainReportFinished</b>(<i>reply</i>) 193 <b>__getDomainReportFinished</b>(<i>reply</i>)
185
186 <p> 194 <p>
187 Private slot to process the IP address report data. 195 Private slot to process the IP address report data.
188 </p> 196 </p>
197
189 <dl> 198 <dl>
190 199
191 <dt><i>reply</i> (QNetworkReply)</dt> 200 <dt><i>reply</i> (QNetworkReply)</dt>
192 <dd> 201 <dd>
193 reference to the network reply 202 reference to the network reply
194 </dd> 203 </dd>
195 </dl> 204 </dl>
196 <a NAME="VirusTotalAPI.__getFileScanReportUrl" ID="VirusTotalAPI.__getFileScanReportUrl"></a> 205 <a NAME="VirusTotalAPI.__getFileScanReportUrl" ID="VirusTotalAPI.__getFileScanReportUrl"></a>
197 <h4>VirusTotalAPI.__getFileScanReportUrl</h4> 206 <h4>VirusTotalAPI.__getFileScanReportUrl</h4>
198 <b>__getFileScanReportUrl</b>(<i>scanId</i>) 207 <b>__getFileScanReportUrl</b>(<i>scanId</i>)
199
200 <p> 208 <p>
201 Private method to get the report URL for a file scan. 209 Private method to get the report URL for a file scan.
202 </p> 210 </p>
211
203 <dl> 212 <dl>
204 213
205 <dt><i>scanId</i> (str)</dt> 214 <dt><i>scanId</i> (str)</dt>
206 <dd> 215 <dd>
207 ID of the scan to get the report URL for 216 ID of the scan to get the report URL for
208 </dd> 217 </dd>
209 </dl> 218 </dl>
210 <a NAME="VirusTotalAPI.__getFileScanReportUrlFinished" ID="VirusTotalAPI.__getFileScanReportUrlFinished"></a> 219 <a NAME="VirusTotalAPI.__getFileScanReportUrlFinished" ID="VirusTotalAPI.__getFileScanReportUrlFinished"></a>
211 <h4>VirusTotalAPI.__getFileScanReportUrlFinished</h4> 220 <h4>VirusTotalAPI.__getFileScanReportUrlFinished</h4>
212 <b>__getFileScanReportUrlFinished</b>(<i>reply</i>) 221 <b>__getFileScanReportUrlFinished</b>(<i>reply</i>)
213
214 <p> 222 <p>
215 Private slot to determine the result of the file scan report URL 223 Private slot to determine the result of the file scan report URL
216 request. 224 request.
217 </p> 225 </p>
226
218 <dl> 227 <dl>
219 228
220 <dt><i>reply</i> (QNetworkReply)</dt> 229 <dt><i>reply</i> (QNetworkReply)</dt>
221 <dd> 230 <dd>
222 reference to the network reply 231 reference to the network reply
223 </dd> 232 </dd>
224 </dl> 233 </dl>
225 <a NAME="VirusTotalAPI.__getIpAddressReportFinished" ID="VirusTotalAPI.__getIpAddressReportFinished"></a> 234 <a NAME="VirusTotalAPI.__getIpAddressReportFinished" ID="VirusTotalAPI.__getIpAddressReportFinished"></a>
226 <h4>VirusTotalAPI.__getIpAddressReportFinished</h4> 235 <h4>VirusTotalAPI.__getIpAddressReportFinished</h4>
227 <b>__getIpAddressReportFinished</b>(<i>reply</i>) 236 <b>__getIpAddressReportFinished</b>(<i>reply</i>)
228
229 <p> 237 <p>
230 Private slot to process the IP address report data. 238 Private slot to process the IP address report data.
231 </p> 239 </p>
240
232 <dl> 241 <dl>
233 242
234 <dt><i>reply</i> (QNetworkReply)</dt> 243 <dt><i>reply</i> (QNetworkReply)</dt>
235 <dd> 244 <dd>
236 reference to the network reply 245 reference to the network reply
237 </dd> 246 </dd>
238 </dl> 247 </dl>
239 <a NAME="VirusTotalAPI.__getUrlScanReportUrl" ID="VirusTotalAPI.__getUrlScanReportUrl"></a> 248 <a NAME="VirusTotalAPI.__getUrlScanReportUrl" ID="VirusTotalAPI.__getUrlScanReportUrl"></a>
240 <h4>VirusTotalAPI.__getUrlScanReportUrl</h4> 249 <h4>VirusTotalAPI.__getUrlScanReportUrl</h4>
241 <b>__getUrlScanReportUrl</b>(<i>scanId</i>) 250 <b>__getUrlScanReportUrl</b>(<i>scanId</i>)
242
243 <p> 251 <p>
244 Private method to get the report URL for a URL scan. 252 Private method to get the report URL for a URL scan.
245 </p> 253 </p>
254
246 <dl> 255 <dl>
247 256
248 <dt><i>scanId</i> (str)</dt> 257 <dt><i>scanId</i> (str)</dt>
249 <dd> 258 <dd>
250 ID of the scan to get the report URL for 259 ID of the scan to get the report URL for
251 </dd> 260 </dd>
252 </dl> 261 </dl>
253 <a NAME="VirusTotalAPI.__getUrlScanReportUrlFinished" ID="VirusTotalAPI.__getUrlScanReportUrlFinished"></a> 262 <a NAME="VirusTotalAPI.__getUrlScanReportUrlFinished" ID="VirusTotalAPI.__getUrlScanReportUrlFinished"></a>
254 <h4>VirusTotalAPI.__getUrlScanReportUrlFinished</h4> 263 <h4>VirusTotalAPI.__getUrlScanReportUrlFinished</h4>
255 <b>__getUrlScanReportUrlFinished</b>(<i>reply</i>) 264 <b>__getUrlScanReportUrlFinished</b>(<i>reply</i>)
256
257 <p> 265 <p>
258 Private slot to determine the result of the URL scan report URL. 266 Private slot to determine the result of the URL scan report URL.
259 </p> 267 </p>
268
260 <dl> 269 <dl>
261 270
262 <dt><i>reply</i> (QNetworkReply)</dt> 271 <dt><i>reply</i> (QNetworkReply)</dt>
263 <dd> 272 <dd>
264 reference to the network reply 273 reference to the network reply
266 </dd> 275 </dd>
267 </dl> 276 </dl>
268 <a NAME="VirusTotalAPI.__loadSettings" ID="VirusTotalAPI.__loadSettings"></a> 277 <a NAME="VirusTotalAPI.__loadSettings" ID="VirusTotalAPI.__loadSettings"></a>
269 <h4>VirusTotalAPI.__loadSettings</h4> 278 <h4>VirusTotalAPI.__loadSettings</h4>
270 <b>__loadSettings</b>(<i></i>) 279 <b>__loadSettings</b>(<i></i>)
271
272 <p> 280 <p>
273 Private method to load the settings. 281 Private method to load the settings.
274 </p> 282 </p>
283
275 <a NAME="VirusTotalAPI.__submitUrlFinished" ID="VirusTotalAPI.__submitUrlFinished"></a> 284 <a NAME="VirusTotalAPI.__submitUrlFinished" ID="VirusTotalAPI.__submitUrlFinished"></a>
276 <h4>VirusTotalAPI.__submitUrlFinished</h4> 285 <h4>VirusTotalAPI.__submitUrlFinished</h4>
277 <b>__submitUrlFinished</b>(<i>reply</i>) 286 <b>__submitUrlFinished</b>(<i>reply</i>)
278
279 <p> 287 <p>
280 Private slot to determine the result of the URL scan submission. 288 Private slot to determine the result of the URL scan submission.
281 </p> 289 </p>
290
282 <dl> 291 <dl>
283 292
284 <dt><i>reply</i> (QNetworkReply)</dt> 293 <dt><i>reply</i> (QNetworkReply)</dt>
285 <dd> 294 <dd>
286 reference to the network reply 295 reference to the network reply
287 </dd> 296 </dd>
288 </dl> 297 </dl>
289 <a NAME="VirusTotalAPI.checkServiceKeyValidity" ID="VirusTotalAPI.checkServiceKeyValidity"></a> 298 <a NAME="VirusTotalAPI.checkServiceKeyValidity" ID="VirusTotalAPI.checkServiceKeyValidity"></a>
290 <h4>VirusTotalAPI.checkServiceKeyValidity</h4> 299 <h4>VirusTotalAPI.checkServiceKeyValidity</h4>
291 <b>checkServiceKeyValidity</b>(<i>key, protocol=""</i>) 300 <b>checkServiceKeyValidity</b>(<i>key, protocol=""</i>)
292
293 <p> 301 <p>
294 Public method to check the validity of the given service key. 302 Public method to check the validity of the given service key.
295 </p> 303 </p>
304
296 <dl> 305 <dl>
297 306
298 <dt><i>key</i> (str)</dt> 307 <dt><i>key</i> (str)</dt>
299 <dd> 308 <dd>
300 service key 309 service key
305 </dd> 314 </dd>
306 </dl> 315 </dl>
307 <a NAME="VirusTotalAPI.close" ID="VirusTotalAPI.close"></a> 316 <a NAME="VirusTotalAPI.close" ID="VirusTotalAPI.close"></a>
308 <h4>VirusTotalAPI.close</h4> 317 <h4>VirusTotalAPI.close</h4>
309 <b>close</b>(<i></i>) 318 <b>close</b>(<i></i>)
310
311 <p> 319 <p>
312 Public slot to close the API. 320 Public slot to close the API.
313 </p> 321 </p>
322
314 <a NAME="VirusTotalAPI.getDomainReport" ID="VirusTotalAPI.getDomainReport"></a> 323 <a NAME="VirusTotalAPI.getDomainReport" ID="VirusTotalAPI.getDomainReport"></a>
315 <h4>VirusTotalAPI.getDomainReport</h4> 324 <h4>VirusTotalAPI.getDomainReport</h4>
316 <b>getDomainReport</b>(<i>domain</i>) 325 <b>getDomainReport</b>(<i>domain</i>)
317
318 <p> 326 <p>
319 Public method to retrieve a report for a domain. 327 Public method to retrieve a report for a domain.
320 </p> 328 </p>
329
321 <dl> 330 <dl>
322 331
323 <dt><i>domain</i> (str)</dt> 332 <dt><i>domain</i> (str)</dt>
324 <dd> 333 <dd>
325 domain name 334 domain name
326 </dd> 335 </dd>
327 </dl> 336 </dl>
328 <a NAME="VirusTotalAPI.getIpAddressReport" ID="VirusTotalAPI.getIpAddressReport"></a> 337 <a NAME="VirusTotalAPI.getIpAddressReport" ID="VirusTotalAPI.getIpAddressReport"></a>
329 <h4>VirusTotalAPI.getIpAddressReport</h4> 338 <h4>VirusTotalAPI.getIpAddressReport</h4>
330 <b>getIpAddressReport</b>(<i>ipAddress</i>) 339 <b>getIpAddressReport</b>(<i>ipAddress</i>)
331
332 <p> 340 <p>
333 Public method to retrieve a report for an IP address. 341 Public method to retrieve a report for an IP address.
334 </p> 342 </p>
343
335 <dl> 344 <dl>
336 345
337 <dt><i>ipAddress</i> (str)</dt> 346 <dt><i>ipAddress</i> (str)</dt>
338 <dd> 347 <dd>
339 valid IPv4 address in dotted quad notation 348 valid IPv4 address in dotted quad notation
340 </dd> 349 </dd>
341 </dl> 350 </dl>
342 <a NAME="VirusTotalAPI.preferencesChanged" ID="VirusTotalAPI.preferencesChanged"></a> 351 <a NAME="VirusTotalAPI.preferencesChanged" ID="VirusTotalAPI.preferencesChanged"></a>
343 <h4>VirusTotalAPI.preferencesChanged</h4> 352 <h4>VirusTotalAPI.preferencesChanged</h4>
344 <b>preferencesChanged</b>(<i></i>) 353 <b>preferencesChanged</b>(<i></i>)
345
346 <p> 354 <p>
347 Public slot to handle a change of preferences. 355 Public slot to handle a change of preferences.
348 </p> 356 </p>
357
349 <a NAME="VirusTotalAPI.submitUrl" ID="VirusTotalAPI.submitUrl"></a> 358 <a NAME="VirusTotalAPI.submitUrl" ID="VirusTotalAPI.submitUrl"></a>
350 <h4>VirusTotalAPI.submitUrl</h4> 359 <h4>VirusTotalAPI.submitUrl</h4>
351 <b>submitUrl</b>(<i>url</i>) 360 <b>submitUrl</b>(<i>url</i>)
352
353 <p> 361 <p>
354 Public method to submit an URL to be scanned. 362 Public method to submit an URL to be scanned.
355 </p> 363 </p>
364
356 <dl> 365 <dl>
357 366
358 <dt><i>url</i> (QUrl)</dt> 367 <dt><i>url</i> (QUrl)</dt>
359 <dd> 368 <dd>
360 url to be scanned 369 url to be scanned

Mercurial Repository: eric

eric ide

mercurial