--- a/src/eric7/Documentation/Source/eric7.WebBrowser.SafeBrowsing.SafeBrowsingAPIClient.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.WebBrowser.SafeBrowsing.SafeBrowsingAPIClient.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,37 +7,36 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.WebBrowser.SafeBrowsing.SafeBrowsingAPIClient</h1>
-
<p>
Module implementing the low level interface for Google Safe Browsing.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#SafeBrowsingAPIClient">SafeBrowsingAPIClient</a></td>
<td>Class implementing the low level interface for Google Safe Browsing.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="SafeBrowsingAPIClient" ID="SafeBrowsingAPIClient"></a>
<h2>SafeBrowsingAPIClient</h2>
-
<p>
Class implementing the low level interface for Google Safe Browsing.
</p>
+
<h3>Signals</h3>
<dl>
@@ -49,14 +48,14 @@
<h3>Derived from</h3>
QObject
<h3>Class Attributes</h3>
-
<table>
-<tr><td>ClientId</td></tr><tr><td>ClientVersion</td></tr><tr><td>GsbUrlTemplate</td></tr>
+<tr><td>ClientId</td></tr>
+<tr><td>ClientVersion</td></tr>
+<tr><td>GsbUrlTemplate</td></tr>
</table>
+
<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>
@@ -90,10 +89,9 @@
<td>Class method to get a display string for a given threat type.</td>
</tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#SafeBrowsingAPIClient.__init__">SafeBrowsingAPIClient</a></td>
<td>Constructor</td>
@@ -135,19 +133,20 @@
<td>Public method to set the API key.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<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>Return:</dt>
<dd>
@@ -163,10 +162,10 @@
<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>Return:</dt>
<dd>
@@ -182,10 +181,10 @@
<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>Return:</dt>
<dd>
@@ -201,10 +200,10 @@
<a NAME="SafeBrowsingAPIClient.getPlatformString" ID="SafeBrowsingAPIClient.getPlatformString"></a>
<h4>SafeBrowsingAPIClient.getPlatformString (class method)</h4>
<b>getPlatformString</b>(<i>platformType</i>)
-
<p>
Class method to get the platform string for a given platform type.
</p>
+
<dl>
<dt><i>platformType</i> (str)</dt>
@@ -227,10 +226,10 @@
<a NAME="SafeBrowsingAPIClient.getPlatformTypes" ID="SafeBrowsingAPIClient.getPlatformTypes"></a>
<h4>SafeBrowsingAPIClient.getPlatformTypes (class method)</h4>
<b>getPlatformTypes</b>(<i>platform</i>)
-
<p>
Class method to get the platform types for a given platform.
</p>
+
<dl>
<dt><i>platform</i> (str (one of 'linux', 'windows', 'macos'))</dt>
@@ -261,10 +260,10 @@
<a NAME="SafeBrowsingAPIClient.getThreatEntryString" ID="SafeBrowsingAPIClient.getThreatEntryString"></a>
<h4>SafeBrowsingAPIClient.getThreatEntryString (class method)</h4>
<b>getThreatEntryString</b>(<i>threatEntry</i>)
-
<p>
Class method to get the threat entry string.
</p>
+
<dl>
<dt><i>threatEntry</i> (str)</dt>
@@ -287,10 +286,10 @@
<a NAME="SafeBrowsingAPIClient.getThreatMessage" ID="SafeBrowsingAPIClient.getThreatMessage"></a>
<h4>SafeBrowsingAPIClient.getThreatMessage (class method)</h4>
<b>getThreatMessage</b>(<i>threatType</i>)
-
<p>
Class method to get a warning message for the given threat type.
</p>
+
<dl>
<dt><i>threatType</i> (str)</dt>
@@ -313,10 +312,10 @@
<a NAME="SafeBrowsingAPIClient.getThreatType" ID="SafeBrowsingAPIClient.getThreatType"></a>
<h4>SafeBrowsingAPIClient.getThreatType (class method)</h4>
<b>getThreatType</b>(<i>threatType</i>)
-
<p>
Class method to get a display string for a given threat type.
</p>
+
<dl>
<dt><i>threatType</i> (str)</dt>
@@ -339,10 +338,10 @@
<a NAME="SafeBrowsingAPIClient.__init__" ID="SafeBrowsingAPIClient.__init__"></a>
<h4>SafeBrowsingAPIClient (Constructor)</h4>
<b>SafeBrowsingAPIClient</b>(<i>apiKey, fairUse=True, parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>apiKey</i> (str)</dt>
@@ -361,10 +360,10 @@
<a NAME="SafeBrowsingAPIClient.__extractData" ID="SafeBrowsingAPIClient.__extractData"></a>
<h4>SafeBrowsingAPIClient.__extractData</h4>
<b>__extractData</b>(<i>reply</i>)
-
<p>
Private method to extract the data of a network reply.
</p>
+
<dl>
<dt><i>reply</i> (QNetworkReply)</dt>
@@ -387,10 +386,10 @@
<a NAME="SafeBrowsingAPIClient.__setWaitDuration" ID="SafeBrowsingAPIClient.__setWaitDuration"></a>
<h4>SafeBrowsingAPIClient.__setWaitDuration</h4>
<b>__setWaitDuration</b>(<i>minimumWaitDuration</i>)
-
<p>
Private method to set the minimum wait duration.
</p>
+
<dl>
<dt><i>minimumWaitDuration</i> (str)</dt>
@@ -401,10 +400,10 @@
<a NAME="SafeBrowsingAPIClient.fairUseDelayExpired" ID="SafeBrowsingAPIClient.fairUseDelayExpired"></a>
<h4>SafeBrowsingAPIClient.fairUseDelayExpired</h4>
<b>fairUseDelayExpired</b>(<i></i>)
-
<p>
Public method to check, if the fair use wait period has expired.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -420,10 +419,10 @@
<a NAME="SafeBrowsingAPIClient.getFairUseDelayExpirationDateTime" ID="SafeBrowsingAPIClient.getFairUseDelayExpirationDateTime"></a>
<h4>SafeBrowsingAPIClient.getFairUseDelayExpirationDateTime</h4>
<b>getFairUseDelayExpirationDateTime</b>(<i></i>)
-
<p>
Public method to get the date and time the fair use delay will expire.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -439,10 +438,10 @@
<a NAME="SafeBrowsingAPIClient.getFullHashes" ID="SafeBrowsingAPIClient.getFullHashes"></a>
<h4>SafeBrowsingAPIClient.getFullHashes</h4>
<b>getFullHashes</b>(<i>prefixes, clientState</i>)
-
<p>
Public method to find full hashes matching hash prefixes.
</p>
+
<dl>
<dt><i>prefixes</i> (list of bytes)</dt>
@@ -471,10 +470,10 @@
<a NAME="SafeBrowsingAPIClient.getThreatLists" ID="SafeBrowsingAPIClient.getThreatLists"></a>
<h4>SafeBrowsingAPIClient.getThreatLists</h4>
<b>getThreatLists</b>(<i></i>)
-
<p>
Public method to retrieve all available threat lists.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -491,10 +490,10 @@
<a NAME="SafeBrowsingAPIClient.getThreatsUpdate" ID="SafeBrowsingAPIClient.getThreatsUpdate"></a>
<h4>SafeBrowsingAPIClient.getThreatsUpdate</h4>
<b>getThreatsUpdate</b>(<i>clientStates</i>)
-
<p>
Public method to fetch hash prefix updates for the given threat list.
</p>
+
<dl>
<dt><i>clientStates</i> (dict)</dt>
@@ -519,10 +518,10 @@
<a NAME="SafeBrowsingAPIClient.lookupUrl" ID="SafeBrowsingAPIClient.lookupUrl"></a>
<h4>SafeBrowsingAPIClient.lookupUrl</h4>
<b>lookupUrl</b>(<i>url, platforms</i>)
-
<p>
Public method to send an URL to Google for checking.
</p>
+
<dl>
<dt><i>url</i> (QUrl)</dt>
@@ -550,10 +549,10 @@
<a NAME="SafeBrowsingAPIClient.setApiKey" ID="SafeBrowsingAPIClient.setApiKey"></a>
<h4>SafeBrowsingAPIClient.setApiKey</h4>
<b>setApiKey</b>(<i>apiKey</i>)
-
<p>
Public method to set the API key.
</p>
+
<dl>
<dt><i>apiKey</i> (str)</dt>
@@ -563,4 +562,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
