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

<!DOCTYPE html>
<html><head>
<title>eric7.WebBrowser.SafeBrowsing.SafeBrowsingThreatList</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.WebBrowser.SafeBrowsing.SafeBrowsingThreatList</h1>
<p>
Module implementing the threat list info class.
</p>

<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>

<h3>Classes</h3>
<table>
<tr>
<td><a href="#HashPrefixList">HashPrefixList</a></td>
<td>Class implementing a container for threat list data.</td>
</tr>
<tr>
<td><a href="#ThreatList">ThreatList</a></td>
<td>Class implementing the threat list info.</td>
</tr>
</table>

<h3>Functions</h3>
<table>
<tr><td>None</td></tr>
</table>

<hr />
<hr />
<a NAME="HashPrefixList" ID="HashPrefixList"></a>
<h2>HashPrefixList</h2>
<p>
    Class implementing a container for threat list data.
</p>

<h3>Derived from</h3>
None
<h3>Class Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>

<h3>Class Methods</h3>
<table>
<tr><td>None</td></tr>
</table>

<h3>Methods</h3>
<table>
<tr>
<td><a href="#HashPrefixList.__init__">HashPrefixList</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#HashPrefixList.__iter__">__iter__</a></td>
<td>Special method to iterate over the raw hashes.</td>
</tr>
<tr>
<td><a href="#HashPrefixList.__len__">__len__</a></td>
<td>Special method to calculate the number of entries.</td>
</tr>
</table>

<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>


<a NAME="HashPrefixList.__init__" ID="HashPrefixList.__init__"></a>
<h4>HashPrefixList (Constructor)</h4>
<b>HashPrefixList</b>(<i>prefixLength, rawHashes</i>)
<p>
        Constructor
</p>

<dl>

<dt><i>prefixLength</i> (int)</dt>
<dd>
length of each hash prefix
</dd>
<dt><i>rawHashes</i> (str)</dt>
<dd>
raw hash prefixes of given length concatenated and
            sorted in lexicographical order
</dd>
</dl>
<a NAME="HashPrefixList.__iter__" ID="HashPrefixList.__iter__"></a>
<h4>HashPrefixList.__iter__</h4>
<b>__iter__</b>(<i></i>)
<p>
        Special method to iterate over the raw hashes.
</p>

<dl>
<dt>Return:</dt>
<dd>
iterator object
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
iterator
</dd>
</dl>
<a NAME="HashPrefixList.__len__" ID="HashPrefixList.__len__"></a>
<h4>HashPrefixList.__len__</h4>
<b>__len__</b>(<i></i>)
<p>
        Special method to calculate the number of entries.
</p>

<dl>
<dt>Return:</dt>
<dd>
length
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
int
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="ThreatList" ID="ThreatList"></a>
<h2>ThreatList</h2>
<p>
    Class implementing the threat list info.
</p>

<h3>Derived from</h3>
None
<h3>Class Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>

<h3>Class Methods</h3>
<table>
<tr>
<td><a href="#ThreatList.fromApiEntry">fromApiEntry</a></td>
<td>Class method to instantiate a threat list given a threat list entry dictionary.</td>
</tr>
</table>

<h3>Methods</h3>
<table>
<tr>
<td><a href="#ThreatList.__init__">ThreatList</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#ThreatList.__repr__">__repr__</a></td>
<td>Special method to generate a printable representation.</td>
</tr>
<tr>
<td><a href="#ThreatList.asTuple">asTuple</a></td>
<td>Public method to convert the object to a tuple.</td>
</tr>
</table>

<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>


<a NAME="ThreatList.fromApiEntry" ID="ThreatList.fromApiEntry"></a>
<h4>ThreatList.fromApiEntry (class method)</h4>
<b>fromApiEntry</b>(<i>entry</i>)
<p>
        Class method to instantiate a threat list given a threat list entry
        dictionary.
</p>

<dl>

<dt><i>entry</i> (dict)</dt>
<dd>
threat list entry dictionary
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
instantiated object
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
ThreatList
</dd>
</dl>
<a NAME="ThreatList.__init__" ID="ThreatList.__init__"></a>
<h4>ThreatList (Constructor)</h4>
<b>ThreatList</b>(<i>threatType, platformType, threatEntryType</i>)
<p>
        Constructor
</p>

<dl>

<dt><i>threatType</i> (str)</dt>
<dd>
threat type
</dd>
<dt><i>platformType</i> (str)</dt>
<dd>
platform type
</dd>
<dt><i>threatEntryType</i> (str)</dt>
<dd>
threat entry type
</dd>
</dl>
<a NAME="ThreatList.__repr__" ID="ThreatList.__repr__"></a>
<h4>ThreatList.__repr__</h4>
<b>__repr__</b>(<i></i>)
<p>
        Special method to generate a printable representation.
</p>

<dl>
<dt>Return:</dt>
<dd>
printable representation
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<a NAME="ThreatList.asTuple" ID="ThreatList.asTuple"></a>
<h4>ThreatList.asTuple</h4>
<b>asTuple</b>(<i></i>)
<p>
        Public method to convert the object to a tuple.
</p>

<dl>
<dt>Return:</dt>
<dd>
tuple containing the threat list info
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
tuple of (str, str, str)
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>