Documentation/Source/eric5.Helpviewer.VirusTotalApi.html

changeset 1228
7afaf2fca55b
parent 993
03493183dd91
child 1229
a8207dc73672
equal deleted inserted replaced
1227:c5db073a124f 1228:7afaf2fca55b
42 <hr /><hr /> 42 <hr /><hr />
43 <a NAME="VirusTotalAPI" ID="VirusTotalAPI"></a> 43 <a NAME="VirusTotalAPI" ID="VirusTotalAPI"></a>
44 <h2>VirusTotalAPI</h2> 44 <h2>VirusTotalAPI</h2>
45 <p> 45 <p>
46 Class implementing the <a href="http://www.virustotal.com">VirusTotal</a> API. 46 Class implementing the <a href="http://www.virustotal.com">VirusTotal</a> API.
47 </p><h4>Signals</h4> 47 </p><h3>Signals</h3>
48 <dl> 48 <dl>
49 <dt>checkServiceKeyFinished(bool, str)</dt> 49 <dt>checkServiceKeyFinished(bool, str)</dt>
50 <dd> 50 <dd>
51 emitted after the service key check 51 emitted after the service key check
52 has been performed. It gives a flag indicating validity (boolean) and 52 has been performed. It gives a flag indicating validity (boolean) and
67 QObject 67 QObject
68 <h3>Class Attributes</h3> 68 <h3>Class Attributes</h3>
69 <table> 69 <table>
70 <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> 70 <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>
71 </table> 71 </table>
72 <h3>Class Methods</h3>
73 <table>
74 <tr>
75 <td><a href="#VirusTotalAPI.getSearchRequestData">getSearchRequestData</a></td>
76 <td>Class method to assemble the search request data structure.</td>
77 </tr>
78 </table>
72 <h3>Methods</h3> 79 <h3>Methods</h3>
73 <table> 80 <table>
74 <tr> 81 <tr>
75 <td><a href="#VirusTotalAPI.__init__">VirusTotalAPI</a></td>
76 <td>Constructor</td>
77 </tr><tr>
78 <td><a href="#VirusTotalAPI.__checkServiceKeyValidityFinished">__checkServiceKeyValidityFinished</a></td> 82 <td><a href="#VirusTotalAPI.__checkServiceKeyValidityFinished">__checkServiceKeyValidityFinished</a></td>
79 <td>Private slot to determine the result of the service key validity check.</td> 83 <td>Private slot to determine the result of the service key validity check.</td>
80 </tr><tr> 84 </tr><tr>
81 <td><a href="#VirusTotalAPI.__getFileScanReportUrl">__getFileScanReportUrl</a></td> 85 <td><a href="#VirusTotalAPI.__getFileScanReportUrl">__getFileScanReportUrl</a></td>
82 <td>Private method to get the report URL for a file scan.</td> 86 <td>Private method to get the report URL for a file scan.</td>
90 <td><a href="#VirusTotalAPI.__submitUrlFinished">__submitUrlFinished</a></td> 94 <td><a href="#VirusTotalAPI.__submitUrlFinished">__submitUrlFinished</a></td>
91 <td>Private slot to determine the result of the URL scan submission.</td> 95 <td>Private slot to determine the result of the URL scan submission.</td>
92 </tr><tr> 96 </tr><tr>
93 <td><a href="#VirusTotalAPI.checkServiceKeyValidity">checkServiceKeyValidity</a></td> 97 <td><a href="#VirusTotalAPI.checkServiceKeyValidity">checkServiceKeyValidity</a></td>
94 <td>Public method to check the validity of the given service key.</td> 98 <td>Public method to check the validity of the given service key.</td>
95 </tr><tr>
96 <td><a href="#VirusTotalAPI.getSearchRequestData">getSearchRequestData</a></td>
97 <td>Class method to assemble the search request data structure.</td>
98 </tr><tr> 99 </tr><tr>
99 <td><a href="#VirusTotalAPI.preferencesChanged">preferencesChanged</a></td> 100 <td><a href="#VirusTotalAPI.preferencesChanged">preferencesChanged</a></td>
100 <td>Public slot to handle a change of preferences.</td> 101 <td>Public slot to handle a change of preferences.</td>
101 </tr><tr> 102 </tr><tr>
102 <td><a href="#VirusTotalAPI.submitUrl">submitUrl</a></td> 103 <td><a href="#VirusTotalAPI.submitUrl">submitUrl</a></td>
103 <td>Public method to submit an URL to be scanned.</td> 104 <td>Public method to submit an URL to be scanned.</td>
104 </tr> 105 </tr>
105 </table> 106 </table>
106 <a NAME="VirusTotalAPI.__init__" ID="VirusTotalAPI.__init__"></a> 107 <h3>Static Methods</h3>
108 <table>
109 <tr><td>None</td></tr>
110 </table>
111 <a NAME="VirusTotalAPI.getSearchRequestData" ID="VirusTotalAPI.getSearchRequestData"></a>
112 <h4>VirusTotalAPI.getSearchRequestData (class method)</h4>
113 <b>getSearchRequestData</b>(<i>term</i>)
114 <p>
115 Class method to assemble the search request data structure.
116 </p><dl>
117 <dt><i>term</i></dt>
118 <dd>
119 search term (string)
120 </dd>
121 </dl><dl>
122 <dt>Returns:</dt>
123 <dd>
124 tuple of network request object, operation and parameters
125 (QNetworkRequest, QNetworkAccessManager.Operation, QByteArray)
126 </dd>
127 </dl><a NAME="VirusTotalAPI.__init__" ID="VirusTotalAPI.__init__"></a>
107 <h4>VirusTotalAPI (Constructor)</h4> 128 <h4>VirusTotalAPI (Constructor)</h4>
108 <b>VirusTotalAPI</b>(<i>parent=None</i>) 129 <b>VirusTotalAPI</b>(<i>parent=None</i>)
109 <p> 130 <p>
110 Constructor 131 Constructor
111 </p><dl> 132 </p><dl>
165 <dt>Returns:</dt> 186 <dt>Returns:</dt>
166 <dd> 187 <dd>
167 flag indicating validity (boolean) and an error message in 188 flag indicating validity (boolean) and an error message in
168 case of a network error (string) 189 case of a network error (string)
169 </dd> 190 </dd>
170 </dl><a NAME="VirusTotalAPI.getSearchRequestData" ID="VirusTotalAPI.getSearchRequestData"></a>
171 <h4>VirusTotalAPI.getSearchRequestData</h4>
172 <b>getSearchRequestData</b>(<i>term</i>)
173 <p>
174 Class method to assemble the search request data structure.
175 </p><dl>
176 <dt><i>term</i></dt>
177 <dd>
178 search term (string)
179 </dd>
180 </dl><dl>
181 <dt>Returns:</dt>
182 <dd>
183 tuple of network request object, operation and parameters
184 (QNetworkRequest, QNetworkAccessManager.Operation, QByteArray)
185 </dd>
186 </dl><a NAME="VirusTotalAPI.preferencesChanged" ID="VirusTotalAPI.preferencesChanged"></a> 191 </dl><a NAME="VirusTotalAPI.preferencesChanged" ID="VirusTotalAPI.preferencesChanged"></a>
187 <h4>VirusTotalAPI.preferencesChanged</h4> 192 <h4>VirusTotalAPI.preferencesChanged</h4>
188 <b>preferencesChanged</b>(<i></i>) 193 <b>preferencesChanged</b>(<i></i>)
189 <p> 194 <p>
190 Public slot to handle a change of preferences. 195 Public slot to handle a change of preferences.

eric ide

mercurial