Documentation/Source/eric6.WebBrowser.SafeBrowsing.SafeBrowsingAPIClient.html

changeset 6234
fb1f9e681848
parent 6233
a64b986abb54
diff -r a64b986abb54 -r fb1f9e681848 Documentation/Source/eric6.WebBrowser.SafeBrowsing.SafeBrowsingAPIClient.html
--- a/Documentation/Source/eric6.WebBrowser.SafeBrowsing.SafeBrowsingAPIClient.html	Wed Apr 11 19:57:23 2018 +0200
+++ b/Documentation/Source/eric6.WebBrowser.SafeBrowsing.SafeBrowsingAPIClient.html	Thu Apr 12 19:12:36 2018 +0200
@@ -59,6 +59,15 @@
 <h3>Class Methods</h3>
 <table>
 <tr>
+<td><a href="#SafeBrowsingAPIClient.definedPlatformTypes">definedPlatformTypes</a></td>
+<td>Class method to get all platform types defined in API v4.</td>
+</tr><tr>
+<td><a href="#SafeBrowsingAPIClient.definedThreatEntryTypes">definedThreatEntryTypes</a></td>
+<td>Class method to get all threat entry types defined in API v4.</td>
+</tr><tr>
+<td><a href="#SafeBrowsingAPIClient.definedThreatTypes">definedThreatTypes</a></td>
+<td>Class method to get all threat types defined in API v4.</td>
+</tr><tr>
 <td><a href="#SafeBrowsingAPIClient.getPlatformString">getPlatformString</a></td>
 <td>Class method to get the platform string for a given platform type.</td>
 </tr><tr>
@@ -113,7 +122,52 @@
 <table>
 <tr><td>None</td></tr>
 </table>
-<a NAME="SafeBrowsingAPIClient.getPlatformString" ID="SafeBrowsingAPIClient.getPlatformString"></a>
+<a NAME="SafeBrowsingAPIClient.definedPlatformTypes" ID="SafeBrowsingAPIClient.definedPlatformTypes"></a>
+<h4>SafeBrowsingAPIClient.definedPlatformTypes (class method)</h4>
+<b>definedPlatformTypes</b>(<i></i>)
+<p>
+        Class method to get all platform types defined in API v4.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+list of all defined platform types
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
+</dd>
+</dl><a NAME="SafeBrowsingAPIClient.definedThreatEntryTypes" ID="SafeBrowsingAPIClient.definedThreatEntryTypes"></a>
+<h4>SafeBrowsingAPIClient.definedThreatEntryTypes (class method)</h4>
+<b>definedThreatEntryTypes</b>(<i></i>)
+<p>
+        Class method to get all threat entry types defined in API v4.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+list of all defined threat entry types
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
+</dd>
+</dl><a NAME="SafeBrowsingAPIClient.definedThreatTypes" ID="SafeBrowsingAPIClient.definedThreatTypes"></a>
+<h4>SafeBrowsingAPIClient.definedThreatTypes (class method)</h4>
+<b>definedThreatTypes</b>(<i></i>)
+<p>
+        Class method to get all threat types defined in API v4.
+</p><dl>
+<dt>Returns:</dt>
+<dd>
+list of defined threat types
+</dd>
+</dl><dl>
+<dt>Return Type:</dt>
+<dd>
+list of str
+</dd>
+</dl><a NAME="SafeBrowsingAPIClient.getPlatformString" ID="SafeBrowsingAPIClient.getPlatformString"></a>
 <h4>SafeBrowsingAPIClient.getPlatformString (class method)</h4>
 <b>getPlatformString</b>(<i>platformType</i>)
 <p>
@@ -328,13 +382,13 @@
 </p><dl>
 <dt>Returns:</dt>
 <dd>
-list of threat lists
+tuple containing list of threat lists and an error message
 </dd>
 </dl><dl>
 <dt>Return Type:</dt>
 <dd>
-list of dict containing 'threatType', 'platformType' and
-            'threatEntryType'
+tuple of (list of dict containing 'threatType', 'platformType'
+            and 'threatEntryType', bool)
 </dd>
 </dl><a NAME="SafeBrowsingAPIClient.getThreatsUpdate" ID="SafeBrowsingAPIClient.getThreatsUpdate"></a>
 <h4>SafeBrowsingAPIClient.getThreatsUpdate</h4>
@@ -350,12 +404,13 @@
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-list of threat updates
+tuple containing the list of threat updates and an error
+            message
 </dd>
 </dl><dl>
 <dt>Return Type:</dt>
 <dd>
-list of dict
+tuple of (list of dict, bool)
 </dd>
 </dl><a NAME="SafeBrowsingAPIClient.lookupUrl" ID="SafeBrowsingAPIClient.lookupUrl"></a>
 <h4>SafeBrowsingAPIClient.lookupUrl</h4>
@@ -373,12 +428,13 @@
 </dl><dl>
 <dt>Returns:</dt>
 <dd>
-list of threat list info objects
+tuple containing the list of threat list info objects and
+            an error message
 </dd>
 </dl><dl>
 <dt>Return Type:</dt>
 <dd>
-list of ThreatList
+tuple of (list of ThreatList, str)
 </dd>
 </dl><a NAME="SafeBrowsingAPIClient.setApiKey" ID="SafeBrowsingAPIClient.setApiKey"></a>
 <h4>SafeBrowsingAPIClient.setApiKey</h4>

eric ide

mercurial