Mercurial Repositories > eric / file comparison

comparison: src/eric7/Documentation/Source/eric7.WebBrowser.SafeBrowsing.SafeBrowsingAPIClient.html

src/eric7/Documentation/Source/eric7.WebBrowser.SafeBrowsing.SafeBrowsingAPIClient.html

branch
eric7
changeset 10479
856476537696
parent 9209
b99e7fd55fd3
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.SafeBrowsing.SafeBrowsingAPIClient</h1> 9 <h1>eric7.WebBrowser.SafeBrowsing.SafeBrowsingAPIClient</h1>
10
11 <p> 10 <p>
12 Module implementing the low level interface for Google Safe Browsing. 11 Module implementing the low level interface for Google Safe Browsing.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15
16 <table> 15 <table>
17 <tr><td>None</td></tr> 16 <tr><td>None</td></tr>
18 </table> 17 </table>
18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 20 <table>
21 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#SafeBrowsingAPIClient">SafeBrowsingAPIClient</a></td> 22 <td><a href="#SafeBrowsingAPIClient">SafeBrowsingAPIClient</a></td>
25 <td>Class implementing the low level interface for Google Safe Browsing.</td> 23 <td>Class implementing the low level interface for Google Safe Browsing.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29
30 <table> 28 <table>
31 <tr><td>None</td></tr> 29 <tr><td>None</td></tr>
32 </table> 30 </table>
31
33 <hr /> 32 <hr />
34 <hr /> 33 <hr />
35 <a NAME="SafeBrowsingAPIClient" ID="SafeBrowsingAPIClient"></a> 34 <a NAME="SafeBrowsingAPIClient" ID="SafeBrowsingAPIClient"></a>
36 <h2>SafeBrowsingAPIClient</h2> 35 <h2>SafeBrowsingAPIClient</h2>
37
38 <p> 36 <p>
39 Class implementing the low level interface for Google Safe Browsing. 37 Class implementing the low level interface for Google Safe Browsing.
40 </p> 38 </p>
39
41 <h3>Signals</h3> 40 <h3>Signals</h3>
42 <dl> 41 <dl>
43 42
44 <dt>networkError(str)</dt> 43 <dt>networkError(str)</dt>
45 <dd> 44 <dd>
47 </dd> 46 </dd>
48 </dl> 47 </dl>
49 <h3>Derived from</h3> 48 <h3>Derived from</h3>
50 QObject 49 QObject
51 <h3>Class Attributes</h3> 50 <h3>Class Attributes</h3>
52 51 <table>
53 <table> 52 <tr><td>ClientId</td></tr>
54 <tr><td>ClientId</td></tr><tr><td>ClientVersion</td></tr><tr><td>GsbUrlTemplate</td></tr> 53 <tr><td>ClientVersion</td></tr>
55 </table> 54 <tr><td>GsbUrlTemplate</td></tr>
55 </table>
56
56 <h3>Class Methods</h3> 57 <h3>Class Methods</h3>
57 58 <table>
58 <table>
59
60 <tr> 59 <tr>
61 <td><a href="#SafeBrowsingAPIClient.definedPlatformTypes">definedPlatformTypes</a></td> 60 <td><a href="#SafeBrowsingAPIClient.definedPlatformTypes">definedPlatformTypes</a></td>
62 <td>Class method to get all platform types defined in API v4.</td> 61 <td>Class method to get all platform types defined in API v4.</td>
63 </tr> 62 </tr>
64 <tr> 63 <tr>
88 <tr> 87 <tr>
89 <td><a href="#SafeBrowsingAPIClient.getThreatType">getThreatType</a></td> 88 <td><a href="#SafeBrowsingAPIClient.getThreatType">getThreatType</a></td>
90 <td>Class method to get a display string for a given threat type.</td> 89 <td>Class method to get a display string for a given threat type.</td>
91 </tr> 90 </tr>
92 </table> 91 </table>
92
93 <h3>Methods</h3> 93 <h3>Methods</h3>
94 94 <table>
95 <table>
96
97 <tr> 95 <tr>
98 <td><a href="#SafeBrowsingAPIClient.__init__">SafeBrowsingAPIClient</a></td> 96 <td><a href="#SafeBrowsingAPIClient.__init__">SafeBrowsingAPIClient</a></td>
99 <td>Constructor</td> 97 <td>Constructor</td>
100 </tr> 98 </tr>
101 <tr> 99 <tr>
133 <tr> 131 <tr>
134 <td><a href="#SafeBrowsingAPIClient.setApiKey">setApiKey</a></td> 132 <td><a href="#SafeBrowsingAPIClient.setApiKey">setApiKey</a></td>
135 <td>Public method to set the API key.</td> 133 <td>Public method to set the API key.</td>
136 </tr> 134 </tr>
137 </table> 135 </table>
136
138 <h3>Static Methods</h3> 137 <h3>Static Methods</h3>
139
140 <table> 138 <table>
141 <tr><td>None</td></tr> 139 <tr><td>None</td></tr>
142 </table> 140 </table>
141
143 142
144 <a NAME="SafeBrowsingAPIClient.definedPlatformTypes" ID="SafeBrowsingAPIClient.definedPlatformTypes"></a> 143 <a NAME="SafeBrowsingAPIClient.definedPlatformTypes" ID="SafeBrowsingAPIClient.definedPlatformTypes"></a>
145 <h4>SafeBrowsingAPIClient.definedPlatformTypes (class method)</h4> 144 <h4>SafeBrowsingAPIClient.definedPlatformTypes (class method)</h4>
146 <b>definedPlatformTypes</b>(<i></i>) 145 <b>definedPlatformTypes</b>(<i></i>)
147
148 <p> 146 <p>
149 Class method to get all platform types defined in API v4. 147 Class method to get all platform types defined in API v4.
150 </p> 148 </p>
149
151 <dl> 150 <dl>
152 <dt>Return:</dt> 151 <dt>Return:</dt>
153 <dd> 152 <dd>
154 list of all defined platform types 153 list of all defined platform types
155 </dd> 154 </dd>
161 </dd> 160 </dd>
162 </dl> 161 </dl>
163 <a NAME="SafeBrowsingAPIClient.definedThreatEntryTypes" ID="SafeBrowsingAPIClient.definedThreatEntryTypes"></a> 162 <a NAME="SafeBrowsingAPIClient.definedThreatEntryTypes" ID="SafeBrowsingAPIClient.definedThreatEntryTypes"></a>
164 <h4>SafeBrowsingAPIClient.definedThreatEntryTypes (class method)</h4> 163 <h4>SafeBrowsingAPIClient.definedThreatEntryTypes (class method)</h4>
165 <b>definedThreatEntryTypes</b>(<i></i>) 164 <b>definedThreatEntryTypes</b>(<i></i>)
166
167 <p> 165 <p>
168 Class method to get all threat entry types defined in API v4. 166 Class method to get all threat entry types defined in API v4.
169 </p> 167 </p>
168
170 <dl> 169 <dl>
171 <dt>Return:</dt> 170 <dt>Return:</dt>
172 <dd> 171 <dd>
173 list of all defined threat entry types 172 list of all defined threat entry types
174 </dd> 173 </dd>
180 </dd> 179 </dd>
181 </dl> 180 </dl>
182 <a NAME="SafeBrowsingAPIClient.definedThreatTypes" ID="SafeBrowsingAPIClient.definedThreatTypes"></a> 181 <a NAME="SafeBrowsingAPIClient.definedThreatTypes" ID="SafeBrowsingAPIClient.definedThreatTypes"></a>
183 <h4>SafeBrowsingAPIClient.definedThreatTypes (class method)</h4> 182 <h4>SafeBrowsingAPIClient.definedThreatTypes (class method)</h4>
184 <b>definedThreatTypes</b>(<i></i>) 183 <b>definedThreatTypes</b>(<i></i>)
185
186 <p> 184 <p>
187 Class method to get all threat types defined in API v4. 185 Class method to get all threat types defined in API v4.
188 </p> 186 </p>
187
189 <dl> 188 <dl>
190 <dt>Return:</dt> 189 <dt>Return:</dt>
191 <dd> 190 <dd>
192 list of defined threat types 191 list of defined threat types
193 </dd> 192 </dd>
199 </dd> 198 </dd>
200 </dl> 199 </dl>
201 <a NAME="SafeBrowsingAPIClient.getPlatformString" ID="SafeBrowsingAPIClient.getPlatformString"></a> 200 <a NAME="SafeBrowsingAPIClient.getPlatformString" ID="SafeBrowsingAPIClient.getPlatformString"></a>
202 <h4>SafeBrowsingAPIClient.getPlatformString (class method)</h4> 201 <h4>SafeBrowsingAPIClient.getPlatformString (class method)</h4>
203 <b>getPlatformString</b>(<i>platformType</i>) 202 <b>getPlatformString</b>(<i>platformType</i>)
204
205 <p> 203 <p>
206 Class method to get the platform string for a given platform type. 204 Class method to get the platform string for a given platform type.
207 </p> 205 </p>
206
208 <dl> 207 <dl>
209 208
210 <dt><i>platformType</i> (str)</dt> 209 <dt><i>platformType</i> (str)</dt>
211 <dd> 210 <dd>
212 platform type as defined in the v4 API 211 platform type as defined in the v4 API
225 </dd> 224 </dd>
226 </dl> 225 </dl>
227 <a NAME="SafeBrowsingAPIClient.getPlatformTypes" ID="SafeBrowsingAPIClient.getPlatformTypes"></a> 226 <a NAME="SafeBrowsingAPIClient.getPlatformTypes" ID="SafeBrowsingAPIClient.getPlatformTypes"></a>
228 <h4>SafeBrowsingAPIClient.getPlatformTypes (class method)</h4> 227 <h4>SafeBrowsingAPIClient.getPlatformTypes (class method)</h4>
229 <b>getPlatformTypes</b>(<i>platform</i>) 228 <b>getPlatformTypes</b>(<i>platform</i>)
230
231 <p> 229 <p>
232 Class method to get the platform types for a given platform. 230 Class method to get the platform types for a given platform.
233 </p> 231 </p>
232
234 <dl> 233 <dl>
235 234
236 <dt><i>platform</i> (str (one of 'linux', 'windows', 'macos'))</dt> 235 <dt><i>platform</i> (str (one of 'linux', 'windows', 'macos'))</dt>
237 <dd> 236 <dd>
238 platform string 237 platform string
259 </dd> 258 </dd>
260 </dl> 259 </dl>
261 <a NAME="SafeBrowsingAPIClient.getThreatEntryString" ID="SafeBrowsingAPIClient.getThreatEntryString"></a> 260 <a NAME="SafeBrowsingAPIClient.getThreatEntryString" ID="SafeBrowsingAPIClient.getThreatEntryString"></a>
262 <h4>SafeBrowsingAPIClient.getThreatEntryString (class method)</h4> 261 <h4>SafeBrowsingAPIClient.getThreatEntryString (class method)</h4>
263 <b>getThreatEntryString</b>(<i>threatEntry</i>) 262 <b>getThreatEntryString</b>(<i>threatEntry</i>)
264
265 <p> 263 <p>
266 Class method to get the threat entry string. 264 Class method to get the threat entry string.
267 </p> 265 </p>
266
268 <dl> 267 <dl>
269 268
270 <dt><i>threatEntry</i> (str)</dt> 269 <dt><i>threatEntry</i> (str)</dt>
271 <dd> 270 <dd>
272 threat entry type as defined in the v4 API 271 threat entry type as defined in the v4 API
285 </dd> 284 </dd>
286 </dl> 285 </dl>
287 <a NAME="SafeBrowsingAPIClient.getThreatMessage" ID="SafeBrowsingAPIClient.getThreatMessage"></a> 286 <a NAME="SafeBrowsingAPIClient.getThreatMessage" ID="SafeBrowsingAPIClient.getThreatMessage"></a>
288 <h4>SafeBrowsingAPIClient.getThreatMessage (class method)</h4> 287 <h4>SafeBrowsingAPIClient.getThreatMessage (class method)</h4>
289 <b>getThreatMessage</b>(<i>threatType</i>) 288 <b>getThreatMessage</b>(<i>threatType</i>)
290
291 <p> 289 <p>
292 Class method to get a warning message for the given threat type. 290 Class method to get a warning message for the given threat type.
293 </p> 291 </p>
292
294 <dl> 293 <dl>
295 294
296 <dt><i>threatType</i> (str)</dt> 295 <dt><i>threatType</i> (str)</dt>
297 <dd> 296 <dd>
298 threat type to get the message for 297 threat type to get the message for
311 </dd> 310 </dd>
312 </dl> 311 </dl>
313 <a NAME="SafeBrowsingAPIClient.getThreatType" ID="SafeBrowsingAPIClient.getThreatType"></a> 312 <a NAME="SafeBrowsingAPIClient.getThreatType" ID="SafeBrowsingAPIClient.getThreatType"></a>
314 <h4>SafeBrowsingAPIClient.getThreatType (class method)</h4> 313 <h4>SafeBrowsingAPIClient.getThreatType (class method)</h4>
315 <b>getThreatType</b>(<i>threatType</i>) 314 <b>getThreatType</b>(<i>threatType</i>)
316
317 <p> 315 <p>
318 Class method to get a display string for a given threat type. 316 Class method to get a display string for a given threat type.
319 </p> 317 </p>
318
320 <dl> 319 <dl>
321 320
322 <dt><i>threatType</i> (str)</dt> 321 <dt><i>threatType</i> (str)</dt>
323 <dd> 322 <dd>
324 threat type to get display string for 323 threat type to get display string for
337 </dd> 336 </dd>
338 </dl> 337 </dl>
339 <a NAME="SafeBrowsingAPIClient.__init__" ID="SafeBrowsingAPIClient.__init__"></a> 338 <a NAME="SafeBrowsingAPIClient.__init__" ID="SafeBrowsingAPIClient.__init__"></a>
340 <h4>SafeBrowsingAPIClient (Constructor)</h4> 339 <h4>SafeBrowsingAPIClient (Constructor)</h4>
341 <b>SafeBrowsingAPIClient</b>(<i>apiKey, fairUse=True, parent=None</i>) 340 <b>SafeBrowsingAPIClient</b>(<i>apiKey, fairUse=True, parent=None</i>)
342
343 <p> 341 <p>
344 Constructor 342 Constructor
345 </p> 343 </p>
344
346 <dl> 345 <dl>
347 346
348 <dt><i>apiKey</i> (str)</dt> 347 <dt><i>apiKey</i> (str)</dt>
349 <dd> 348 <dd>
350 API key to be used 349 API key to be used
359 </dd> 358 </dd>
360 </dl> 359 </dl>
361 <a NAME="SafeBrowsingAPIClient.__extractData" ID="SafeBrowsingAPIClient.__extractData"></a> 360 <a NAME="SafeBrowsingAPIClient.__extractData" ID="SafeBrowsingAPIClient.__extractData"></a>
362 <h4>SafeBrowsingAPIClient.__extractData</h4> 361 <h4>SafeBrowsingAPIClient.__extractData</h4>
363 <b>__extractData</b>(<i>reply</i>) 362 <b>__extractData</b>(<i>reply</i>)
364
365 <p> 363 <p>
366 Private method to extract the data of a network reply. 364 Private method to extract the data of a network reply.
367 </p> 365 </p>
366
368 <dl> 367 <dl>
369 368
370 <dt><i>reply</i> (QNetworkReply)</dt> 369 <dt><i>reply</i> (QNetworkReply)</dt>
371 <dd> 370 <dd>
372 reference to the network reply object 371 reference to the network reply object
385 </dd> 384 </dd>
386 </dl> 385 </dl>
387 <a NAME="SafeBrowsingAPIClient.__setWaitDuration" ID="SafeBrowsingAPIClient.__setWaitDuration"></a> 386 <a NAME="SafeBrowsingAPIClient.__setWaitDuration" ID="SafeBrowsingAPIClient.__setWaitDuration"></a>
388 <h4>SafeBrowsingAPIClient.__setWaitDuration</h4> 387 <h4>SafeBrowsingAPIClient.__setWaitDuration</h4>
389 <b>__setWaitDuration</b>(<i>minimumWaitDuration</i>) 388 <b>__setWaitDuration</b>(<i>minimumWaitDuration</i>)
390
391 <p> 389 <p>
392 Private method to set the minimum wait duration. 390 Private method to set the minimum wait duration.
393 </p> 391 </p>
392
394 <dl> 393 <dl>
395 394
396 <dt><i>minimumWaitDuration</i> (str)</dt> 395 <dt><i>minimumWaitDuration</i> (str)</dt>
397 <dd> 396 <dd>
398 duration to be set 397 duration to be set
399 </dd> 398 </dd>
400 </dl> 399 </dl>
401 <a NAME="SafeBrowsingAPIClient.fairUseDelayExpired" ID="SafeBrowsingAPIClient.fairUseDelayExpired"></a> 400 <a NAME="SafeBrowsingAPIClient.fairUseDelayExpired" ID="SafeBrowsingAPIClient.fairUseDelayExpired"></a>
402 <h4>SafeBrowsingAPIClient.fairUseDelayExpired</h4> 401 <h4>SafeBrowsingAPIClient.fairUseDelayExpired</h4>
403 <b>fairUseDelayExpired</b>(<i></i>) 402 <b>fairUseDelayExpired</b>(<i></i>)
404
405 <p> 403 <p>
406 Public method to check, if the fair use wait period has expired. 404 Public method to check, if the fair use wait period has expired.
407 </p> 405 </p>
406
408 <dl> 407 <dl>
409 <dt>Return:</dt> 408 <dt>Return:</dt>
410 <dd> 409 <dd>
411 flag indicating expiration 410 flag indicating expiration
412 </dd> 411 </dd>
418 </dd> 417 </dd>
419 </dl> 418 </dl>
420 <a NAME="SafeBrowsingAPIClient.getFairUseDelayExpirationDateTime" ID="SafeBrowsingAPIClient.getFairUseDelayExpirationDateTime"></a> 419 <a NAME="SafeBrowsingAPIClient.getFairUseDelayExpirationDateTime" ID="SafeBrowsingAPIClient.getFairUseDelayExpirationDateTime"></a>
421 <h4>SafeBrowsingAPIClient.getFairUseDelayExpirationDateTime</h4> 420 <h4>SafeBrowsingAPIClient.getFairUseDelayExpirationDateTime</h4>
422 <b>getFairUseDelayExpirationDateTime</b>(<i></i>) 421 <b>getFairUseDelayExpirationDateTime</b>(<i></i>)
423
424 <p> 422 <p>
425 Public method to get the date and time the fair use delay will expire. 423 Public method to get the date and time the fair use delay will expire.
426 </p> 424 </p>
425
427 <dl> 426 <dl>
428 <dt>Return:</dt> 427 <dt>Return:</dt>
429 <dd> 428 <dd>
430 fair use delay expiration date and time 429 fair use delay expiration date and time
431 </dd> 430 </dd>
437 </dd> 436 </dd>
438 </dl> 437 </dl>
439 <a NAME="SafeBrowsingAPIClient.getFullHashes" ID="SafeBrowsingAPIClient.getFullHashes"></a> 438 <a NAME="SafeBrowsingAPIClient.getFullHashes" ID="SafeBrowsingAPIClient.getFullHashes"></a>
440 <h4>SafeBrowsingAPIClient.getFullHashes</h4> 439 <h4>SafeBrowsingAPIClient.getFullHashes</h4>
441 <b>getFullHashes</b>(<i>prefixes, clientState</i>) 440 <b>getFullHashes</b>(<i>prefixes, clientState</i>)
442
443 <p> 441 <p>
444 Public method to find full hashes matching hash prefixes. 442 Public method to find full hashes matching hash prefixes.
445 </p> 443 </p>
444
446 <dl> 445 <dl>
447 446
448 <dt><i>prefixes</i> (list of bytes)</dt> 447 <dt><i>prefixes</i> (list of bytes)</dt>
449 <dd> 448 <dd>
450 list of hash prefixes to find 449 list of hash prefixes to find
469 </dd> 468 </dd>
470 </dl> 469 </dl>
471 <a NAME="SafeBrowsingAPIClient.getThreatLists" ID="SafeBrowsingAPIClient.getThreatLists"></a> 470 <a NAME="SafeBrowsingAPIClient.getThreatLists" ID="SafeBrowsingAPIClient.getThreatLists"></a>
472 <h4>SafeBrowsingAPIClient.getThreatLists</h4> 471 <h4>SafeBrowsingAPIClient.getThreatLists</h4>
473 <b>getThreatLists</b>(<i></i>) 472 <b>getThreatLists</b>(<i></i>)
474
475 <p> 473 <p>
476 Public method to retrieve all available threat lists. 474 Public method to retrieve all available threat lists.
477 </p> 475 </p>
476
478 <dl> 477 <dl>
479 <dt>Return:</dt> 478 <dt>Return:</dt>
480 <dd> 479 <dd>
481 tuple containing list of threat lists and an error message 480 tuple containing list of threat lists and an error message
482 </dd> 481 </dd>
489 </dd> 488 </dd>
490 </dl> 489 </dl>
491 <a NAME="SafeBrowsingAPIClient.getThreatsUpdate" ID="SafeBrowsingAPIClient.getThreatsUpdate"></a> 490 <a NAME="SafeBrowsingAPIClient.getThreatsUpdate" ID="SafeBrowsingAPIClient.getThreatsUpdate"></a>
492 <h4>SafeBrowsingAPIClient.getThreatsUpdate</h4> 491 <h4>SafeBrowsingAPIClient.getThreatsUpdate</h4>
493 <b>getThreatsUpdate</b>(<i>clientStates</i>) 492 <b>getThreatsUpdate</b>(<i>clientStates</i>)
494
495 <p> 493 <p>
496 Public method to fetch hash prefix updates for the given threat list. 494 Public method to fetch hash prefix updates for the given threat list.
497 </p> 495 </p>
496
498 <dl> 497 <dl>
499 498
500 <dt><i>clientStates</i> (dict)</dt> 499 <dt><i>clientStates</i> (dict)</dt>
501 <dd> 500 <dd>
502 dictionary of client states with keys like 501 dictionary of client states with keys like
517 </dd> 516 </dd>
518 </dl> 517 </dl>
519 <a NAME="SafeBrowsingAPIClient.lookupUrl" ID="SafeBrowsingAPIClient.lookupUrl"></a> 518 <a NAME="SafeBrowsingAPIClient.lookupUrl" ID="SafeBrowsingAPIClient.lookupUrl"></a>
520 <h4>SafeBrowsingAPIClient.lookupUrl</h4> 519 <h4>SafeBrowsingAPIClient.lookupUrl</h4>
521 <b>lookupUrl</b>(<i>url, platforms</i>) 520 <b>lookupUrl</b>(<i>url, platforms</i>)
522
523 <p> 521 <p>
524 Public method to send an URL to Google for checking. 522 Public method to send an URL to Google for checking.
525 </p> 523 </p>
524
526 <dl> 525 <dl>
527 526
528 <dt><i>url</i> (QUrl)</dt> 527 <dt><i>url</i> (QUrl)</dt>
529 <dd> 528 <dd>
530 URL to be checked 529 URL to be checked
548 </dd> 547 </dd>
549 </dl> 548 </dl>
550 <a NAME="SafeBrowsingAPIClient.setApiKey" ID="SafeBrowsingAPIClient.setApiKey"></a> 549 <a NAME="SafeBrowsingAPIClient.setApiKey" ID="SafeBrowsingAPIClient.setApiKey"></a>
551 <h4>SafeBrowsingAPIClient.setApiKey</h4> 550 <h4>SafeBrowsingAPIClient.setApiKey</h4>
552 <b>setApiKey</b>(<i>apiKey</i>) 551 <b>setApiKey</b>(<i>apiKey</i>)
553
554 <p> 552 <p>
555 Public method to set the API key. 553 Public method to set the API key.
556 </p> 554 </p>
555
557 <dl> 556 <dl>
558 557
559 <dt><i>apiKey</i> (str)</dt> 558 <dt><i>apiKey</i> (str)</dt>
560 <dd> 559 <dd>
561 API key to be set 560 API key to be set

Mercurial Repository: eric

eric ide

mercurial