--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/Documentation/Source/eric5.Helpviewer.VirusTotalApi.html Sun Apr 10 18:33:20 2011 +0200
@@ -0,0 +1,168 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!DOCTYPE html PUBLIC '-//W3C//DTD XHTML 1.0 Strict//EN'
+'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd'>
+<html><head>
+<title>eric5.Helpviewer.VirusTotalApi</title>
+<style>
+body {
+ background: #EDECE6;
+ margin: 0em 1em 10em 1em;
+ color: black;
+}
+
+h1 { color: white; background: #85774A; }
+h2 { color: white; background: #85774A; }
+h3 { color: white; background: #9D936E; }
+h4 { color: white; background: #9D936E; }
+
+a { color: #BA6D36; }
+
+</style>
+</head>
+<body><a NAME="top" ID="top"></a>
+<h1>eric5.Helpviewer.VirusTotalApi</h1>
+<p>
+Module implementing the <a href="http://www.virustotal.com">VirusTotal</a> API class.
+</p>
+<h3>Global Attributes</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<h3>Classes</h3>
+<table>
+<tr>
+<td><a href="#VirusTotalAPI">VirusTotalAPI</a></td>
+<td>Class implementing the <a href="http://www.virustotal.com">VirusTotal</a> API.</td>
+</tr>
+</table>
+<h3>Functions</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+<hr /><hr />
+<a NAME="VirusTotalAPI" ID="VirusTotalAPI"></a>
+<h2>VirusTotalAPI</h2>
+<p>
+ Class implementing the <a href="http://www.virustotal.com">VirusTotal</a> API.
+</p>
+<h3>Derived from</h3>
+QObject
+<h3>Class Attributes</h3>
+<table>
+<tr><td>GetFileReportPattern</td></tr><tr><td>GetUrlReportPattern</td></tr><tr><td>ReportFileScanPagePattern</td></tr><tr><td>ReportUrlScanPagePattern</td></tr><tr><td>ScanUrlPattern</td></tr><tr><td>SearchUrl</td></tr><tr><td>ServiceResult_InvalidServiceKey</td></tr><tr><td>ServiceResult_ItemNotPresent</td></tr><tr><td>ServiceResult_ItemPresent</td></tr><tr><td>ServiceResult_RequestLimitReached</td></tr><tr><td>TestServiceKeyScanID</td></tr>
+</table>
+<h3>Methods</h3>
+<table>
+<tr>
+<td><a href="#VirusTotalAPI.__init__">VirusTotalAPI</a></td>
+<td>Constructor</td>
+</tr><tr>
+<td><a href="#VirusTotalAPI.__loadSettings">__loadSettings</a></td>
+<td>Private method to load the settings.</td>
+</tr><tr>
+<td><a href="#VirusTotalAPI.checkServiceKeyValidity">checkServiceKeyValidity</a></td>
+<td>Public method to check the validity of the given service key.</td>
+</tr><tr>
+<td><a href="#VirusTotalAPI.getFileScanReportUrl">getFileScanReportUrl</a></td>
+<td>Public method to get the report URL for a file scan.</td>
+</tr><tr>
+<td><a href="#VirusTotalAPI.getSearchRequestData">getSearchRequestData</a></td>
+<td></td>
+</tr><tr>
+<td><a href="#VirusTotalAPI.getUrlScanReportUrl">getUrlScanReportUrl</a></td>
+<td>Public method to get the report URL for a URL scan.</td>
+</tr><tr>
+<td><a href="#VirusTotalAPI.submitUrl">submitUrl</a></td>
+<td>Public method to submit an URL to be scanned.</td>
+</tr>
+</table>
+<a NAME="VirusTotalAPI.__init__" ID="VirusTotalAPI.__init__"></a>
+<h4>VirusTotalAPI (Constructor)</h4>
+<b>VirusTotalAPI</b>(<i>parent=None</i>)
+<p>
+ Constructor
+</p><dl>
+<dt><i>parent</i></dt>
+<dd>
+reference to the parent object (QObject)
+</dd>
+</dl><a NAME="VirusTotalAPI.__loadSettings" ID="VirusTotalAPI.__loadSettings"></a>
+<h4>VirusTotalAPI.__loadSettings</h4>
+<b>__loadSettings</b>(<i></i>)
+<p>
+ Private method to load the settings.
+</p><a NAME="VirusTotalAPI.checkServiceKeyValidity" ID="VirusTotalAPI.checkServiceKeyValidity"></a>
+<h4>VirusTotalAPI.checkServiceKeyValidity</h4>
+<b>checkServiceKeyValidity</b>(<i>key, protocol=""</i>)
+<p>
+ Public method to check the validity of the given service key.
+</p><dl>
+<dt><i>key</i></dt>
+<dd>
+service key (string)
+</dd><dt><i>protocol</i></dt>
+<dd>
+protocol used to access VirusTotal (string)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+flag indicating validity (boolean) and an error message in
+ case of a network error (string)
+</dd>
+</dl><a NAME="VirusTotalAPI.getFileScanReportUrl" ID="VirusTotalAPI.getFileScanReportUrl"></a>
+<h4>VirusTotalAPI.getFileScanReportUrl</h4>
+<b>getFileScanReportUrl</b>(<i>scanId</i>)
+<p>
+ Public method to get the report URL for a file scan.
+</p><dl>
+<dt><i>scanId</i></dt>
+<dd>
+ID of the scan to get the report URL for (string)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+file scan report URL (string)
+</dd>
+</dl><a NAME="VirusTotalAPI.getSearchRequestData" ID="VirusTotalAPI.getSearchRequestData"></a>
+<h4>VirusTotalAPI.getSearchRequestData</h4>
+<b>getSearchRequestData</b>(<i>term</i>)
+<p>
+
+</p><p>
+
+</p><a NAME="VirusTotalAPI.getUrlScanReportUrl" ID="VirusTotalAPI.getUrlScanReportUrl"></a>
+<h4>VirusTotalAPI.getUrlScanReportUrl</h4>
+<b>getUrlScanReportUrl</b>(<i>scanId</i>)
+<p>
+ Public method to get the report URL for a URL scan.
+</p><dl>
+<dt><i>scanId</i></dt>
+<dd>
+ID of the scan to get the report URL for (string)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+URL scan report URL (string)
+</dd>
+</dl><a NAME="VirusTotalAPI.submitUrl" ID="VirusTotalAPI.submitUrl"></a>
+<h4>VirusTotalAPI.submitUrl</h4>
+<b>submitUrl</b>(<i>url</i>)
+<p>
+ Public method to submit an URL to be scanned.
+</p><dl>
+<dt><i>url</i></dt>
+<dd>
+url to be scanned (QUrl)
+</dd>
+</dl><dl>
+<dt>Returns:</dt>
+<dd>
+flag indicating success (boolean) and the scan ID (string)
+</dd>
+</dl>
+<div align="right"><a href="#top">Up</a></div>
+<hr />
+</body></html>
\ No newline at end of file
