Mercurial Repositories > eric / file comparison

comparison: Documentation/Source/eric6.Helpviewer.VirusTotal.VirusTotalApi.html

Documentation/Source/eric6.Helpviewer.VirusTotal.VirusTotalApi.html

changeset 4336
473bf2a8676f
child 6123
39cd368143db
equal deleted inserted replaced
4335:a25c157625c4 4336:473bf2a8676f
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.Helpviewer.VirusTotal.VirusTotalApi</title>
4 <meta charset="UTF-8">
5 <style>
6 body {
7 background: #EDECE6;
8 margin: 0em 1em 10em 1em;
9 color: black;
10 }
11
12 h1 { color: white; background: #85774A; }
13 h2 { color: white; background: #85774A; }
14 h3 { color: white; background: #9D936E; }
15 h4 { color: white; background: #9D936E; }
16
17 a { color: #BA6D36; }
18
19 </style>
20 </head>
21 <body><a NAME="top" ID="top"></a>
22 <h1>eric6.Helpviewer.VirusTotal.VirusTotalApi</h1>
23 <p>
24 Module implementing the <a href="http://www.virustotal.com">VirusTotal</a>
25 API class.
26 </p>
27 <h3>Global Attributes</h3>
28 <table>
29 <tr><td>None</td></tr>
30 </table>
31 <h3>Classes</h3>
32 <table>
33 <tr>
34 <td><a href="#VirusTotalAPI">VirusTotalAPI</a></td>
35 <td>Class implementing the <a href="http://www.virustotal.com">VirusTotal</a> API.</td>
36 </tr>
37 </table>
38 <h3>Functions</h3>
39 <table>
40 <tr><td>None</td></tr>
41 </table>
42 <hr /><hr />
43 <a NAME="VirusTotalAPI" ID="VirusTotalAPI"></a>
44 <h2>VirusTotalAPI</h2>
45 <p>
46 Class implementing the <a href="http://www.virustotal.com">VirusTotal</a>
47 API.
48 </p><h3>Signals</h3>
49 <dl>
50 <dt>checkServiceKeyFinished(bool, str)</dt>
51 <dd>
52 emitted after the service key
53 check has been performed. It gives a flag indicating validity
54 (boolean) and an error message in case of a network error (string).
55 </dd><dt>fileScanReport(str)</dt>
56 <dd>
57 emitted with the URL of the file scan report
58 page
59 </dd><dt>submitUrlError(str)</dt>
60 <dd>
61 emitted with the error string, if the URL scan
62 submission returned an error.
63 </dd><dt>urlScanReport(str)</dt>
64 <dd>
65 emitted with the URL of the URL scan report page
66 </dd>
67 </dl>
68 <h3>Derived from</h3>
69 QObject
70 <h3>Class Attributes</h3>
71 <table>
72 <tr><td>GetDomainReportPattern</td></tr><tr><td>GetFileReportPattern</td></tr><tr><td>GetIpAddressReportPattern</td></tr><tr><td>GetUrlReportPattern</td></tr><tr><td>ScanUrlPattern</td></tr><tr><td>ServiceCode_InvalidKey</td></tr><tr><td>ServiceCode_InvalidPrivilege</td></tr><tr><td>ServiceCode_RateLimitExceeded</td></tr><tr><td>ServiceResult_ItemNotPresent</td></tr><tr><td>ServiceResult_ItemPresent</td></tr><tr><td>ServiceResult_ItemQueued</td></tr><tr><td>TestServiceKeyScanID</td></tr>
73 </table>
74 <h3>Class Methods</h3>
75 <table>
76 <tr><td>None</td></tr>
77 </table>
78 <h3>Methods</h3>
79 <table>
80 <tr>
81 <td><a href="#VirusTotalAPI.__init__">VirusTotalAPI</a></td>
82 <td>Constructor</td>
83 </tr><tr>
84 <td><a href="#VirusTotalAPI.__checkServiceKeyValidityFinished">__checkServiceKeyValidityFinished</a></td>
85 <td>Private slot to determine the result of the service key validity check.</td>
86 </tr><tr>
87 <td><a href="#VirusTotalAPI.__getDomainReportFinished">__getDomainReportFinished</a></td>
88 <td>Private slot to process the IP address report data.</td>
89 </tr><tr>
90 <td><a href="#VirusTotalAPI.__getFileScanReportUrl">__getFileScanReportUrl</a></td>
91 <td>Private method to get the report URL for a file scan.</td>
92 </tr><tr>
93 <td><a href="#VirusTotalAPI.__getFileScanReportUrlFinished">__getFileScanReportUrlFinished</a></td>
94 <td>Private slot to determine the result of the file scan report URL request.</td>
95 </tr><tr>
96 <td><a href="#VirusTotalAPI.__getIpAddressReportFinished">__getIpAddressReportFinished</a></td>
97 <td>Private slot to process the IP address report data.</td>
98 </tr><tr>
99 <td><a href="#VirusTotalAPI.__getUrlScanReportUrl">__getUrlScanReportUrl</a></td>
100 <td>Private method to get the report URL for a URL scan.</td>
101 </tr><tr>
102 <td><a href="#VirusTotalAPI.__getUrlScanReportUrlFinished">__getUrlScanReportUrlFinished</a></td>
103 <td>Private slot to determine the result of the URL scan report URL request.</td>
104 </tr><tr>
105 <td><a href="#VirusTotalAPI.__loadSettings">__loadSettings</a></td>
106 <td>Private method to load the settings.</td>
107 </tr><tr>
108 <td><a href="#VirusTotalAPI.__submitUrlFinished">__submitUrlFinished</a></td>
109 <td>Private slot to determine the result of the URL scan submission.</td>
110 </tr><tr>
111 <td><a href="#VirusTotalAPI.checkServiceKeyValidity">checkServiceKeyValidity</a></td>
112 <td>Public method to check the validity of the given service key.</td>
113 </tr><tr>
114 <td><a href="#VirusTotalAPI.close">close</a></td>
115 <td>Public slot to close the API.</td>
116 </tr><tr>
117 <td><a href="#VirusTotalAPI.getDomainReport">getDomainReport</a></td>
118 <td>Public method to retrieve a report for a domain.</td>
119 </tr><tr>
120 <td><a href="#VirusTotalAPI.getIpAddressReport">getIpAddressReport</a></td>
121 <td>Public method to retrieve a report for an IP address.</td>
122 </tr><tr>
123 <td><a href="#VirusTotalAPI.preferencesChanged">preferencesChanged</a></td>
124 <td>Public slot to handle a change of preferences.</td>
125 </tr><tr>
126 <td><a href="#VirusTotalAPI.submitUrl">submitUrl</a></td>
127 <td>Public method to submit an URL to be scanned.</td>
128 </tr>
129 </table>
130 <h3>Static Methods</h3>
131 <table>
132 <tr><td>None</td></tr>
133 </table>
134 <a NAME="VirusTotalAPI.__init__" ID="VirusTotalAPI.__init__"></a>
135 <h4>VirusTotalAPI (Constructor)</h4>
136 <b>VirusTotalAPI</b>(<i>parent=None</i>)
137 <p>
138 Constructor
139 </p><dl>
140 <dt><i>parent</i></dt>
141 <dd>
142 reference to the parent object (QObject)
143 </dd>
144 </dl><a NAME="VirusTotalAPI.__checkServiceKeyValidityFinished" ID="VirusTotalAPI.__checkServiceKeyValidityFinished"></a>
145 <h4>VirusTotalAPI.__checkServiceKeyValidityFinished</h4>
146 <b>__checkServiceKeyValidityFinished</b>(<i></i>)
147 <p>
148 Private slot to determine the result of the service key validity check.
149 </p><a NAME="VirusTotalAPI.__getDomainReportFinished" ID="VirusTotalAPI.__getDomainReportFinished"></a>
150 <h4>VirusTotalAPI.__getDomainReportFinished</h4>
151 <b>__getDomainReportFinished</b>(<i></i>)
152 <p>
153 Private slot to process the IP address report data.
154 </p><a NAME="VirusTotalAPI.__getFileScanReportUrl" ID="VirusTotalAPI.__getFileScanReportUrl"></a>
155 <h4>VirusTotalAPI.__getFileScanReportUrl</h4>
156 <b>__getFileScanReportUrl</b>(<i>scanId</i>)
157 <p>
158 Private method to get the report URL for a file scan.
159 </p><dl>
160 <dt><i>scanId</i></dt>
161 <dd>
162 ID of the scan to get the report URL for (string)
163 </dd>
164 </dl><a NAME="VirusTotalAPI.__getFileScanReportUrlFinished" ID="VirusTotalAPI.__getFileScanReportUrlFinished"></a>
165 <h4>VirusTotalAPI.__getFileScanReportUrlFinished</h4>
166 <b>__getFileScanReportUrlFinished</b>(<i></i>)
167 <p>
168 Private slot to determine the result of the file scan report URL
169 request.
170 </p><a NAME="VirusTotalAPI.__getIpAddressReportFinished" ID="VirusTotalAPI.__getIpAddressReportFinished"></a>
171 <h4>VirusTotalAPI.__getIpAddressReportFinished</h4>
172 <b>__getIpAddressReportFinished</b>(<i></i>)
173 <p>
174 Private slot to process the IP address report data.
175 </p><a NAME="VirusTotalAPI.__getUrlScanReportUrl" ID="VirusTotalAPI.__getUrlScanReportUrl"></a>
176 <h4>VirusTotalAPI.__getUrlScanReportUrl</h4>
177 <b>__getUrlScanReportUrl</b>(<i>scanId</i>)
178 <p>
179 Private method to get the report URL for a URL scan.
180 </p><dl>
181 <dt><i>scanId</i></dt>
182 <dd>
183 ID of the scan to get the report URL for (string)
184 </dd>
185 </dl><a NAME="VirusTotalAPI.__getUrlScanReportUrlFinished" ID="VirusTotalAPI.__getUrlScanReportUrlFinished"></a>
186 <h4>VirusTotalAPI.__getUrlScanReportUrlFinished</h4>
187 <b>__getUrlScanReportUrlFinished</b>(<i></i>)
188 <p>
189 Private slot to determine the result of the URL scan report URL
190 request.
191 </p><a NAME="VirusTotalAPI.__loadSettings" ID="VirusTotalAPI.__loadSettings"></a>
192 <h4>VirusTotalAPI.__loadSettings</h4>
193 <b>__loadSettings</b>(<i></i>)
194 <p>
195 Private method to load the settings.
196 </p><a NAME="VirusTotalAPI.__submitUrlFinished" ID="VirusTotalAPI.__submitUrlFinished"></a>
197 <h4>VirusTotalAPI.__submitUrlFinished</h4>
198 <b>__submitUrlFinished</b>(<i></i>)
199 <p>
200 Private slot to determine the result of the URL scan submission.
201 </p><a NAME="VirusTotalAPI.checkServiceKeyValidity" ID="VirusTotalAPI.checkServiceKeyValidity"></a>
202 <h4>VirusTotalAPI.checkServiceKeyValidity</h4>
203 <b>checkServiceKeyValidity</b>(<i>key, protocol=""</i>)
204 <p>
205 Public method to check the validity of the given service key.
206 </p><dl>
207 <dt><i>key</i></dt>
208 <dd>
209 service key (string)
210 </dd><dt><i>protocol</i></dt>
211 <dd>
212 protocol used to access VirusTotal (string)
213 </dd>
214 </dl><a NAME="VirusTotalAPI.close" ID="VirusTotalAPI.close"></a>
215 <h4>VirusTotalAPI.close</h4>
216 <b>close</b>(<i></i>)
217 <p>
218 Public slot to close the API.
219 </p><a NAME="VirusTotalAPI.getDomainReport" ID="VirusTotalAPI.getDomainReport"></a>
220 <h4>VirusTotalAPI.getDomainReport</h4>
221 <b>getDomainReport</b>(<i>domain</i>)
222 <p>
223 Public method to retrieve a report for a domain.
224 </p><dl>
225 <dt><i>domain</i> (str)</dt>
226 <dd>
227 domain name
228 </dd>
229 </dl><a NAME="VirusTotalAPI.getIpAddressReport" ID="VirusTotalAPI.getIpAddressReport"></a>
230 <h4>VirusTotalAPI.getIpAddressReport</h4>
231 <b>getIpAddressReport</b>(<i>ipAddress</i>)
232 <p>
233 Public method to retrieve a report for an IP address.
234 </p><dl>
235 <dt><i>ipAddress</i> (str)</dt>
236 <dd>
237 valid IPv4 address in dotted quad notation
238 </dd>
239 </dl><a NAME="VirusTotalAPI.preferencesChanged" ID="VirusTotalAPI.preferencesChanged"></a>
240 <h4>VirusTotalAPI.preferencesChanged</h4>
241 <b>preferencesChanged</b>(<i></i>)
242 <p>
243 Public slot to handle a change of preferences.
244 </p><a NAME="VirusTotalAPI.submitUrl" ID="VirusTotalAPI.submitUrl"></a>
245 <h4>VirusTotalAPI.submitUrl</h4>
246 <b>submitUrl</b>(<i>url</i>)
247 <p>
248 Public method to submit an URL to be scanned.
249 </p><dl>
250 <dt><i>url</i></dt>
251 <dd>
252 url to be scanned (QUrl)
253 </dd>
254 </dl>
255 <div align="right"><a href="#top">Up</a></div>
256 <hr />
257 </body></html>

Mercurial Repository: eric

eric ide

mercurial