Mercurial Repositories > eric / file comparison

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

Documentation/Source/eric6.Helpviewer.VirusTotalApi.html

changeset 4335
a25c157625c4
parent 3673
e26d7d0c1088
equal deleted inserted replaced
4334:423ddcc8c815 4335:a25c157625c4
67 </dl> 67 </dl>
68 <h3>Derived from</h3> 68 <h3>Derived from</h3>
69 QObject 69 QObject
70 <h3>Class Attributes</h3> 70 <h3>Class Attributes</h3>
71 <table> 71 <table>
72 <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> 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> 73 </table>
74 <h3>Class Methods</h3> 74 <h3>Class Methods</h3>
75 <table> 75 <table>
76 <tr> 76 <tr><td>None</td></tr>
77 <td><a href="#VirusTotalAPI.getSearchRequestData">getSearchRequestData</a></td>
78 <td>Class method to assemble the search request data structure.</td>
79 </tr>
80 </table> 77 </table>
81 <h3>Methods</h3> 78 <h3>Methods</h3>
82 <table> 79 <table>
83 <tr> 80 <tr>
84 <td><a href="#VirusTotalAPI.__init__">VirusTotalAPI</a></td> 81 <td><a href="#VirusTotalAPI.__init__">VirusTotalAPI</a></td>
85 <td>Constructor</td> 82 <td>Constructor</td>
86 </tr><tr> 83 </tr><tr>
87 <td><a href="#VirusTotalAPI.__checkServiceKeyValidityFinished">__checkServiceKeyValidityFinished</a></td> 84 <td><a href="#VirusTotalAPI.__checkServiceKeyValidityFinished">__checkServiceKeyValidityFinished</a></td>
88 <td>Private slot to determine the result of the service key validity check.</td> 85 <td>Private slot to determine the result of the service key validity check.</td>
89 </tr><tr> 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> 90 <td><a href="#VirusTotalAPI.__getFileScanReportUrl">__getFileScanReportUrl</a></td>
91 <td>Private method to get the report URL for a file scan.</td> 91 <td>Private method to get the report URL for a file scan.</td>
92 </tr><tr> 92 </tr><tr>
93 <td><a href="#VirusTotalAPI.__getFileScanReportUrlFinished">__getFileScanReportUrlFinished</a></td> 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> 94 <td>Private slot to determine the result of the file scan report URL request.</td>
95 </tr><tr> 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>
96 <td><a href="#VirusTotalAPI.__loadSettings">__loadSettings</a></td> 105 <td><a href="#VirusTotalAPI.__loadSettings">__loadSettings</a></td>
97 <td>Private method to load the settings.</td> 106 <td>Private method to load the settings.</td>
98 </tr><tr> 107 </tr><tr>
99 <td><a href="#VirusTotalAPI.__submitUrlFinished">__submitUrlFinished</a></td> 108 <td><a href="#VirusTotalAPI.__submitUrlFinished">__submitUrlFinished</a></td>
100 <td>Private slot to determine the result of the URL scan submission.</td> 109 <td>Private slot to determine the result of the URL scan submission.</td>
101 </tr><tr> 110 </tr><tr>
102 <td><a href="#VirusTotalAPI.checkServiceKeyValidity">checkServiceKeyValidity</a></td> 111 <td><a href="#VirusTotalAPI.checkServiceKeyValidity">checkServiceKeyValidity</a></td>
103 <td>Public method to check the validity of the given service key.</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>
104 </tr><tr> 122 </tr><tr>
105 <td><a href="#VirusTotalAPI.preferencesChanged">preferencesChanged</a></td> 123 <td><a href="#VirusTotalAPI.preferencesChanged">preferencesChanged</a></td>
106 <td>Public slot to handle a change of preferences.</td> 124 <td>Public slot to handle a change of preferences.</td>
107 </tr><tr> 125 </tr><tr>
108 <td><a href="#VirusTotalAPI.submitUrl">submitUrl</a></td> 126 <td><a href="#VirusTotalAPI.submitUrl">submitUrl</a></td>
111 </table> 129 </table>
112 <h3>Static Methods</h3> 130 <h3>Static Methods</h3>
113 <table> 131 <table>
114 <tr><td>None</td></tr> 132 <tr><td>None</td></tr>
115 </table> 133 </table>
116 <a NAME="VirusTotalAPI.getSearchRequestData" ID="VirusTotalAPI.getSearchRequestData"></a> 134 <a NAME="VirusTotalAPI.__init__" ID="VirusTotalAPI.__init__"></a>
117 <h4>VirusTotalAPI.getSearchRequestData (class method)</h4>
118 <b>getSearchRequestData</b>(<i>term</i>)
119 <p>
120 Class method to assemble the search request data structure.
121 </p><dl>
122 <dt><i>term</i></dt>
123 <dd>
124 search term (string)
125 </dd>
126 </dl><dl>
127 <dt>Returns:</dt>
128 <dd>
129 tuple of network request object, operation and parameters
130 (QNetworkRequest, QNetworkAccessManager.Operation, QByteArray)
131 </dd>
132 </dl><a NAME="VirusTotalAPI.__init__" ID="VirusTotalAPI.__init__"></a>
133 <h4>VirusTotalAPI (Constructor)</h4> 135 <h4>VirusTotalAPI (Constructor)</h4>
134 <b>VirusTotalAPI</b>(<i>parent=None</i>) 136 <b>VirusTotalAPI</b>(<i>parent=None</i>)
135 <p> 137 <p>
136 Constructor 138 Constructor
137 </p><dl> 139 </p><dl>
142 </dl><a NAME="VirusTotalAPI.__checkServiceKeyValidityFinished" ID="VirusTotalAPI.__checkServiceKeyValidityFinished"></a> 144 </dl><a NAME="VirusTotalAPI.__checkServiceKeyValidityFinished" ID="VirusTotalAPI.__checkServiceKeyValidityFinished"></a>
143 <h4>VirusTotalAPI.__checkServiceKeyValidityFinished</h4> 145 <h4>VirusTotalAPI.__checkServiceKeyValidityFinished</h4>
144 <b>__checkServiceKeyValidityFinished</b>(<i></i>) 146 <b>__checkServiceKeyValidityFinished</b>(<i></i>)
145 <p> 147 <p>
146 Private slot to determine the result of the service key validity check. 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.
147 </p><a NAME="VirusTotalAPI.__getFileScanReportUrl" ID="VirusTotalAPI.__getFileScanReportUrl"></a> 154 </p><a NAME="VirusTotalAPI.__getFileScanReportUrl" ID="VirusTotalAPI.__getFileScanReportUrl"></a>
148 <h4>VirusTotalAPI.__getFileScanReportUrl</h4> 155 <h4>VirusTotalAPI.__getFileScanReportUrl</h4>
149 <b>__getFileScanReportUrl</b>(<i>scanId</i>) 156 <b>__getFileScanReportUrl</b>(<i>scanId</i>)
150 <p> 157 <p>
151 Private method to get the report URL for a file scan. 158 Private method to get the report URL for a file scan.
157 </dl><a NAME="VirusTotalAPI.__getFileScanReportUrlFinished" ID="VirusTotalAPI.__getFileScanReportUrlFinished"></a> 164 </dl><a NAME="VirusTotalAPI.__getFileScanReportUrlFinished" ID="VirusTotalAPI.__getFileScanReportUrlFinished"></a>
158 <h4>VirusTotalAPI.__getFileScanReportUrlFinished</h4> 165 <h4>VirusTotalAPI.__getFileScanReportUrlFinished</h4>
159 <b>__getFileScanReportUrlFinished</b>(<i></i>) 166 <b>__getFileScanReportUrlFinished</b>(<i></i>)
160 <p> 167 <p>
161 Private slot to determine the result of the file scan report URL 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
162 request. 190 request.
163 </p><a NAME="VirusTotalAPI.__loadSettings" ID="VirusTotalAPI.__loadSettings"></a> 191 </p><a NAME="VirusTotalAPI.__loadSettings" ID="VirusTotalAPI.__loadSettings"></a>
164 <h4>VirusTotalAPI.__loadSettings</h4> 192 <h4>VirusTotalAPI.__loadSettings</h4>
165 <b>__loadSettings</b>(<i></i>) 193 <b>__loadSettings</b>(<i></i>)
166 <p> 194 <p>
181 service key (string) 209 service key (string)
182 </dd><dt><i>protocol</i></dt> 210 </dd><dt><i>protocol</i></dt>
183 <dd> 211 <dd>
184 protocol used to access VirusTotal (string) 212 protocol used to access VirusTotal (string)
185 </dd> 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>
186 </dl><a NAME="VirusTotalAPI.preferencesChanged" ID="VirusTotalAPI.preferencesChanged"></a> 239 </dl><a NAME="VirusTotalAPI.preferencesChanged" ID="VirusTotalAPI.preferencesChanged"></a>
187 <h4>VirusTotalAPI.preferencesChanged</h4> 240 <h4>VirusTotalAPI.preferencesChanged</h4>
188 <b>preferencesChanged</b>(<i></i>) 241 <b>preferencesChanged</b>(<i></i>)
189 <p> 242 <p>
190 Public slot to handle a change of preferences. 243 Public slot to handle a change of preferences.

Mercurial Repository: eric

eric ide

mercurial