Mercurial Repositories > eric / file comparison
comparison: Documentation/Source/eric6.WebBrowser.SafeBrowsing.SafeBrowsingAPIClient.html
Documentation/Source/eric6.WebBrowser.SafeBrowsing.SafeBrowsingAPIClient.html
- changeset 6234
- fb1f9e681848
- parent 6233
- a64b986abb54
equal
deleted
inserted
replaced
| 6233:a64b986abb54 | 6234:fb1f9e681848 |
|---|---|
| 57 <tr><td>ClientId</td></tr><tr><td>ClientVersion</td></tr><tr><td>GsbUrlTemplate</td></tr> | 57 <tr><td>ClientId</td></tr><tr><td>ClientVersion</td></tr><tr><td>GsbUrlTemplate</td></tr> |
| 58 </table> | 58 </table> |
| 59 <h3>Class Methods</h3> | 59 <h3>Class Methods</h3> |
| 60 <table> | 60 <table> |
| 61 <tr> | 61 <tr> |
| 62 <td><a href="#SafeBrowsingAPIClient.definedPlatformTypes">definedPlatformTypes</a></td> | |
| 63 <td>Class method to get all platform types defined in API v4.</td> | |
| 64 </tr><tr> | |
| 65 <td><a href="#SafeBrowsingAPIClient.definedThreatEntryTypes">definedThreatEntryTypes</a></td> | |
| 66 <td>Class method to get all threat entry types defined in API v4.</td> | |
| 67 </tr><tr> | |
| 68 <td><a href="#SafeBrowsingAPIClient.definedThreatTypes">definedThreatTypes</a></td> | |
| 69 <td>Class method to get all threat types defined in API v4.</td> | |
| 70 </tr><tr> | |
| 62 <td><a href="#SafeBrowsingAPIClient.getPlatformString">getPlatformString</a></td> | 71 <td><a href="#SafeBrowsingAPIClient.getPlatformString">getPlatformString</a></td> |
| 63 <td>Class method to get the platform string for a given platform type.</td> | 72 <td>Class method to get the platform string for a given platform type.</td> |
| 64 </tr><tr> | 73 </tr><tr> |
| 65 <td><a href="#SafeBrowsingAPIClient.getPlatformTypes">getPlatformTypes</a></td> | 74 <td><a href="#SafeBrowsingAPIClient.getPlatformTypes">getPlatformTypes</a></td> |
| 66 <td>Class method to get the platform types for a given platform.</td> | 75 <td>Class method to get the platform types for a given platform.</td> |
| 111 </table> | 120 </table> |
| 112 <h3>Static Methods</h3> | 121 <h3>Static Methods</h3> |
| 113 <table> | 122 <table> |
| 114 <tr><td>None</td></tr> | 123 <tr><td>None</td></tr> |
| 115 </table> | 124 </table> |
| 116 <a NAME="SafeBrowsingAPIClient.getPlatformString" ID="SafeBrowsingAPIClient.getPlatformString"></a> | 125 <a NAME="SafeBrowsingAPIClient.definedPlatformTypes" ID="SafeBrowsingAPIClient.definedPlatformTypes"></a> |
| 126 <h4>SafeBrowsingAPIClient.definedPlatformTypes (class method)</h4> | |
| 127 <b>definedPlatformTypes</b>(<i></i>) | |
| 128 <p> | |
| 129 Class method to get all platform types defined in API v4. | |
| 130 </p><dl> | |
| 131 <dt>Returns:</dt> | |
| 132 <dd> | |
| 133 list of all defined platform types | |
| 134 </dd> | |
| 135 </dl><dl> | |
| 136 <dt>Return Type:</dt> | |
| 137 <dd> | |
| 138 list of str | |
| 139 </dd> | |
| 140 </dl><a NAME="SafeBrowsingAPIClient.definedThreatEntryTypes" ID="SafeBrowsingAPIClient.definedThreatEntryTypes"></a> | |
| 141 <h4>SafeBrowsingAPIClient.definedThreatEntryTypes (class method)</h4> | |
| 142 <b>definedThreatEntryTypes</b>(<i></i>) | |
| 143 <p> | |
| 144 Class method to get all threat entry types defined in API v4. | |
| 145 </p><dl> | |
| 146 <dt>Returns:</dt> | |
| 147 <dd> | |
| 148 list of all defined threat entry types | |
| 149 </dd> | |
| 150 </dl><dl> | |
| 151 <dt>Return Type:</dt> | |
| 152 <dd> | |
| 153 list of str | |
| 154 </dd> | |
| 155 </dl><a NAME="SafeBrowsingAPIClient.definedThreatTypes" ID="SafeBrowsingAPIClient.definedThreatTypes"></a> | |
| 156 <h4>SafeBrowsingAPIClient.definedThreatTypes (class method)</h4> | |
| 157 <b>definedThreatTypes</b>(<i></i>) | |
| 158 <p> | |
| 159 Class method to get all threat types defined in API v4. | |
| 160 </p><dl> | |
| 161 <dt>Returns:</dt> | |
| 162 <dd> | |
| 163 list of defined threat types | |
| 164 </dd> | |
| 165 </dl><dl> | |
| 166 <dt>Return Type:</dt> | |
| 167 <dd> | |
| 168 list of str | |
| 169 </dd> | |
| 170 </dl><a NAME="SafeBrowsingAPIClient.getPlatformString" ID="SafeBrowsingAPIClient.getPlatformString"></a> | |
| 117 <h4>SafeBrowsingAPIClient.getPlatformString (class method)</h4> | 171 <h4>SafeBrowsingAPIClient.getPlatformString (class method)</h4> |
| 118 <b>getPlatformString</b>(<i>platformType</i>) | 172 <b>getPlatformString</b>(<i>platformType</i>) |
| 119 <p> | 173 <p> |
| 120 Class method to get the platform string for a given platform type. | 174 Class method to get the platform string for a given platform type. |
| 121 </p><dl> | 175 </p><dl> |
| 326 <p> | 380 <p> |
| 327 Public method to retrieve all available threat lists. | 381 Public method to retrieve all available threat lists. |
| 328 </p><dl> | 382 </p><dl> |
| 329 <dt>Returns:</dt> | 383 <dt>Returns:</dt> |
| 330 <dd> | 384 <dd> |
| 331 list of threat lists | 385 tuple containing list of threat lists and an error message |
| 332 </dd> | 386 </dd> |
| 333 </dl><dl> | 387 </dl><dl> |
| 334 <dt>Return Type:</dt> | 388 <dt>Return Type:</dt> |
| 335 <dd> | 389 <dd> |
| 336 list of dict containing 'threatType', 'platformType' and | 390 tuple of (list of dict containing 'threatType', 'platformType' |
| 337 'threatEntryType' | 391 and 'threatEntryType', bool) |
| 338 </dd> | 392 </dd> |
| 339 </dl><a NAME="SafeBrowsingAPIClient.getThreatsUpdate" ID="SafeBrowsingAPIClient.getThreatsUpdate"></a> | 393 </dl><a NAME="SafeBrowsingAPIClient.getThreatsUpdate" ID="SafeBrowsingAPIClient.getThreatsUpdate"></a> |
| 340 <h4>SafeBrowsingAPIClient.getThreatsUpdate</h4> | 394 <h4>SafeBrowsingAPIClient.getThreatsUpdate</h4> |
| 341 <b>getThreatsUpdate</b>(<i>clientStates</i>) | 395 <b>getThreatsUpdate</b>(<i>clientStates</i>) |
| 342 <p> | 396 <p> |
| 348 (threatType, platformType, threatEntryType) | 402 (threatType, platformType, threatEntryType) |
| 349 </dd> | 403 </dd> |
| 350 </dl><dl> | 404 </dl><dl> |
| 351 <dt>Returns:</dt> | 405 <dt>Returns:</dt> |
| 352 <dd> | 406 <dd> |
| 353 list of threat updates | 407 tuple containing the list of threat updates and an error |
| 354 </dd> | 408 message |
| 355 </dl><dl> | 409 </dd> |
| 356 <dt>Return Type:</dt> | 410 </dl><dl> |
| 357 <dd> | 411 <dt>Return Type:</dt> |
| 358 list of dict | 412 <dd> |
| 413 tuple of (list of dict, bool) | |
| 359 </dd> | 414 </dd> |
| 360 </dl><a NAME="SafeBrowsingAPIClient.lookupUrl" ID="SafeBrowsingAPIClient.lookupUrl"></a> | 415 </dl><a NAME="SafeBrowsingAPIClient.lookupUrl" ID="SafeBrowsingAPIClient.lookupUrl"></a> |
| 361 <h4>SafeBrowsingAPIClient.lookupUrl</h4> | 416 <h4>SafeBrowsingAPIClient.lookupUrl</h4> |
| 362 <b>lookupUrl</b>(<i>url, platforms</i>) | 417 <b>lookupUrl</b>(<i>url, platforms</i>) |
| 363 <p> | 418 <p> |
| 371 list of platform types to check against | 426 list of platform types to check against |
| 372 </dd> | 427 </dd> |
| 373 </dl><dl> | 428 </dl><dl> |
| 374 <dt>Returns:</dt> | 429 <dt>Returns:</dt> |
| 375 <dd> | 430 <dd> |
| 376 list of threat list info objects | 431 tuple containing the list of threat list info objects and |
| 377 </dd> | 432 an error message |
| 378 </dl><dl> | 433 </dd> |
| 379 <dt>Return Type:</dt> | 434 </dl><dl> |
| 380 <dd> | 435 <dt>Return Type:</dt> |
| 381 list of ThreatList | 436 <dd> |
| 437 tuple of (list of ThreatList, str) | |
| 382 </dd> | 438 </dd> |
| 383 </dl><a NAME="SafeBrowsingAPIClient.setApiKey" ID="SafeBrowsingAPIClient.setApiKey"></a> | 439 </dl><a NAME="SafeBrowsingAPIClient.setApiKey" ID="SafeBrowsingAPIClient.setApiKey"></a> |
| 384 <h4>SafeBrowsingAPIClient.setApiKey</h4> | 440 <h4>SafeBrowsingAPIClient.setApiKey</h4> |
| 385 <b>setApiKey</b>(<i>apiKey</i>) | 441 <b>setApiKey</b>(<i>apiKey</i>) |
| 386 <p> | 442 <p> |
