Mercurial Repositories > eric / file comparison

comparison: eric6/Documentation/Source/eric6.WebBrowser.SafeBrowsing.SafeBrowsingManager.html

eric6/Documentation/Source/eric6.WebBrowser.SafeBrowsing.SafeBrowsingManager.html

changeset 7273
391d6b7b1eff
parent 6942
2602857055c5
child 7959
44e15eda6506
equal deleted inserted replaced
7272:1779dc278077 7273:391d6b7b1eff
16 16
17 a { color: #BA6D36; } 17 a { color: #BA6D36; }
18 18
19 </style> 19 </style>
20 </head> 20 </head>
21 <body><a NAME="top" ID="top"></a> 21 <body>
22 <a NAME="top" ID="top"></a>
22 <h1>eric6.WebBrowser.SafeBrowsing.SafeBrowsingManager</h1> 23 <h1>eric6.WebBrowser.SafeBrowsing.SafeBrowsingManager</h1>
24
23 <p> 25 <p>
24 Module implementing the interface for Google Safe Browsing. 26 Module implementing the interface for Google Safe Browsing.
25 </p> 27 </p>
26 <h3>Global Attributes</h3> 28 <h3>Global Attributes</h3>
29
27 <table> 30 <table>
28 <tr><td>None</td></tr> 31 <tr><td>None</td></tr>
29 </table> 32 </table>
30 <h3>Classes</h3> 33 <h3>Classes</h3>
34
31 <table> 35 <table>
36
32 <tr> 37 <tr>
33 <td><a href="#SafeBrowsingManager">SafeBrowsingManager</a></td> 38 <td><a href="#SafeBrowsingManager">SafeBrowsingManager</a></td>
34 <td>Class implementing the interface for Google Safe Browsing.</td> 39 <td>Class implementing the interface for Google Safe Browsing.</td>
35 </tr> 40 </tr>
36 </table> 41 </table>
37 <h3>Functions</h3> 42 <h3>Functions</h3>
43
38 <table> 44 <table>
39 <tr><td>None</td></tr> 45 <tr><td>None</td></tr>
40 </table> 46 </table>
41 <hr /><hr /> 47 <hr />
48 <hr />
42 <a NAME="SafeBrowsingManager" ID="SafeBrowsingManager"></a> 49 <a NAME="SafeBrowsingManager" ID="SafeBrowsingManager"></a>
43 <h2>SafeBrowsingManager</h2> 50 <h2>SafeBrowsingManager</h2>
51
44 <p> 52 <p>
45 Class implementing the interface for Google Safe Browsing. 53 Class implementing the interface for Google Safe Browsing.
46 </p><h3>Signals</h3> 54 </p>
47 <dl> 55 <h3>Signals</h3>
56 <dl>
57
48 <dt>progress(current)</dt> 58 <dt>progress(current)</dt>
49 <dd> 59 <dd>
50 emitted to signal the current progress 60 emitted to signal the current progress
51 </dd><dt>progressMessage(message,maximum)</dt> 61 </dd>
62 <dt>progressMessage(message,maximum)</dt>
52 <dd> 63 <dd>
53 emitted to give a message for the 64 emitted to give a message for the
54 action about to be performed and the maximum value 65 action about to be performed and the maximum value
55 </dd> 66 </dd>
56 </dl> 67 </dl>
57 <h3>Derived from</h3> 68 <h3>Derived from</h3>
58 QObject 69 QObject
59 <h3>Class Attributes</h3> 70 <h3>Class Attributes</h3>
71
60 <table> 72 <table>
61 <tr><td>enabled</td></tr> 73 <tr><td>enabled</td></tr>
62 </table> 74 </table>
63 <h3>Class Methods</h3> 75 <h3>Class Methods</h3>
76
64 <table> 77 <table>
78
65 <tr> 79 <tr>
66 <td><a href="#SafeBrowsingManager.getIgnoreSchemes">getIgnoreSchemes</a></td> 80 <td><a href="#SafeBrowsingManager.getIgnoreSchemes">getIgnoreSchemes</a></td>
67 <td>Class method to get the schemes not to be checked.</td> 81 <td>Class method to get the schemes not to be checked.</td>
68 </tr><tr> 82 </tr>
83 <tr>
69 <td><a href="#SafeBrowsingManager.isEnabled">isEnabled</a></td> 84 <td><a href="#SafeBrowsingManager.isEnabled">isEnabled</a></td>
70 <td>Class method to check, if safe browsing is enabled.</td> 85 <td>Class method to check, if safe browsing is enabled.</td>
71 </tr> 86 </tr>
72 </table> 87 </table>
73 <h3>Methods</h3> 88 <h3>Methods</h3>
89
74 <table> 90 <table>
91
75 <tr> 92 <tr>
76 <td><a href="#SafeBrowsingManager.__init__">SafeBrowsingManager</a></td> 93 <td><a href="#SafeBrowsingManager.__init__">SafeBrowsingManager</a></td>
77 <td>Constructor</td> 94 <td>Constructor</td>
78 </tr><tr> 95 </tr>
96 <tr>
79 <td><a href="#SafeBrowsingManager.__lookupHashes">__lookupHashes</a></td> 97 <td><a href="#SafeBrowsingManager.__lookupHashes">__lookupHashes</a></td>
80 <td>Private method to lookup the given hashes.</td> 98 <td>Private method to lookup the given hashes.</td>
81 </tr><tr> 99 </tr>
100 <tr>
82 <td><a href="#SafeBrowsingManager.__setAutoUpdateThreatLists">__setAutoUpdateThreatLists</a></td> 101 <td><a href="#SafeBrowsingManager.__setAutoUpdateThreatLists">__setAutoUpdateThreatLists</a></td>
83 <td>Private method to set auto update for the threat lists.</td> 102 <td>Private method to set auto update for the threat lists.</td>
84 </tr><tr> 103 </tr>
104 <tr>
85 <td><a href="#SafeBrowsingManager.__setLookupMethod">__setLookupMethod</a></td> 105 <td><a href="#SafeBrowsingManager.__setLookupMethod">__setLookupMethod</a></td>
86 <td>Private method to set the lookup method (Update API or Lookup API).</td> 106 <td>Private method to set the lookup method (Update API or Lookup API).</td>
87 </tr><tr> 107 </tr>
108 <tr>
88 <td><a href="#SafeBrowsingManager.__setPlatforms">__setPlatforms</a></td> 109 <td><a href="#SafeBrowsingManager.__setPlatforms">__setPlatforms</a></td>
89 <td>Private method to set the platforms to be checked against.</td> 110 <td>Private method to set the platforms to be checked against.</td>
90 </tr><tr> 111 </tr>
112 <tr>
91 <td><a href="#SafeBrowsingManager.__showNotificationMessage">__showNotificationMessage</a></td> 113 <td><a href="#SafeBrowsingManager.__showNotificationMessage">__showNotificationMessage</a></td>
92 <td>Private method to show some message in a notification widget.</td> 114 <td>Private method to show some message in a notification widget.</td>
93 </tr><tr> 115 </tr>
116 <tr>
94 <td><a href="#SafeBrowsingManager.__syncFullHashes">__syncFullHashes</a></td> 117 <td><a href="#SafeBrowsingManager.__syncFullHashes">__syncFullHashes</a></td>
95 <td>Private method to download full hashes matching given prefixes.</td> 118 <td>Private method to download full hashes matching given prefixes.</td>
96 </tr><tr> 119 </tr>
120 <tr>
97 <td><a href="#SafeBrowsingManager.__threatListsUpdateTimerTimeout">__threatListsUpdateTimerTimeout</a></td> 121 <td><a href="#SafeBrowsingManager.__threatListsUpdateTimerTimeout">__threatListsUpdateTimerTimeout</a></td>
98 <td>Private slot to perform the auto update of the threat lists.</td> 122 <td>Private slot to perform the auto update of the threat lists.</td>
99 </tr><tr> 123 </tr>
124 <tr>
100 <td><a href="#SafeBrowsingManager.__verifyThreatListChecksum">__verifyThreatListChecksum</a></td> 125 <td><a href="#SafeBrowsingManager.__verifyThreatListChecksum">__verifyThreatListChecksum</a></td>
101 <td>Private method to verify the local checksum of a threat list with the checksum of the safe browsing server.</td> 126 <td>Private method to verify the local checksum of a threat list with the checksum of the safe browsing server.</td>
102 </tr><tr> 127 </tr>
128 <tr>
103 <td><a href="#SafeBrowsingManager.close">close</a></td> 129 <td><a href="#SafeBrowsingManager.close">close</a></td>
104 <td>Public method to close the safe browsing interface.</td> 130 <td>Public method to close the safe browsing interface.</td>
105 </tr><tr> 131 </tr>
132 <tr>
106 <td><a href="#SafeBrowsingManager.configurationChanged">configurationChanged</a></td> 133 <td><a href="#SafeBrowsingManager.configurationChanged">configurationChanged</a></td>
107 <td>Public method to handle changes of the settings.</td> 134 <td>Public method to handle changes of the settings.</td>
108 </tr><tr> 135 </tr>
136 <tr>
109 <td><a href="#SafeBrowsingManager.fairUseDelayExpired">fairUseDelayExpired</a></td> 137 <td><a href="#SafeBrowsingManager.fairUseDelayExpired">fairUseDelayExpired</a></td>
110 <td>Public method to check, if the fair use wait period has expired.</td> 138 <td>Public method to check, if the fair use wait period has expired.</td>
111 </tr><tr> 139 </tr>
140 <tr>
112 <td><a href="#SafeBrowsingManager.fullCacheCleanup">fullCacheCleanup</a></td> 141 <td><a href="#SafeBrowsingManager.fullCacheCleanup">fullCacheCleanup</a></td>
113 <td>Public method to clean up the cache completely.</td> 142 <td>Public method to clean up the cache completely.</td>
114 </tr><tr> 143 </tr>
144 <tr>
115 <td><a href="#SafeBrowsingManager.getPlatformString">getPlatformString</a></td> 145 <td><a href="#SafeBrowsingManager.getPlatformString">getPlatformString</a></td>
116 <td>Public method to get the platform string for a given platform type.</td> 146 <td>Public method to get the platform string for a given platform type.</td>
117 </tr><tr> 147 </tr>
148 <tr>
118 <td><a href="#SafeBrowsingManager.getThreatEntryString">getThreatEntryString</a></td> 149 <td><a href="#SafeBrowsingManager.getThreatEntryString">getThreatEntryString</a></td>
119 <td>Public method to get the threat entry string.</td> 150 <td>Public method to get the threat entry string.</td>
120 </tr><tr> 151 </tr>
152 <tr>
121 <td><a href="#SafeBrowsingManager.getThreatMessage">getThreatMessage</a></td> 153 <td><a href="#SafeBrowsingManager.getThreatMessage">getThreatMessage</a></td>
122 <td>Public method to get a warning message for the given threat type.</td> 154 <td>Public method to get a warning message for the given threat type.</td>
123 </tr><tr> 155 </tr>
156 <tr>
124 <td><a href="#SafeBrowsingManager.getThreatMessages">getThreatMessages</a></td> 157 <td><a href="#SafeBrowsingManager.getThreatMessages">getThreatMessages</a></td>
125 <td>Public method to get threat messages for the given threats.</td> 158 <td>Public method to get threat messages for the given threats.</td>
126 </tr><tr> 159 </tr>
160 <tr>
127 <td><a href="#SafeBrowsingManager.getThreatType">getThreatType</a></td> 161 <td><a href="#SafeBrowsingManager.getThreatType">getThreatType</a></td>
128 <td>Public method to get a display string for a given threat type.</td> 162 <td>Public method to get a display string for a given threat type.</td>
129 </tr><tr> 163 </tr>
164 <tr>
130 <td><a href="#SafeBrowsingManager.isUpdatingThreatLists">isUpdatingThreatLists</a></td> 165 <td><a href="#SafeBrowsingManager.isUpdatingThreatLists">isUpdatingThreatLists</a></td>
131 <td>Public method to check, if we are in the process of updating the threat lists.</td> 166 <td>Public method to check, if we are in the process of updating the threat lists.</td>
132 </tr><tr> 167 </tr>
168 <tr>
133 <td><a href="#SafeBrowsingManager.lookupUrl">lookupUrl</a></td> 169 <td><a href="#SafeBrowsingManager.lookupUrl">lookupUrl</a></td>
134 <td>Public method to lookup an URL.</td> 170 <td>Public method to lookup an URL.</td>
135 </tr><tr> 171 </tr>
172 <tr>
136 <td><a href="#SafeBrowsingManager.showSafeBrowsingDialog">showSafeBrowsingDialog</a></td> 173 <td><a href="#SafeBrowsingManager.showSafeBrowsingDialog">showSafeBrowsingDialog</a></td>
137 <td>Public slot to show the safe browsing management dialog.</td> 174 <td>Public slot to show the safe browsing management dialog.</td>
138 </tr><tr> 175 </tr>
176 <tr>
139 <td><a href="#SafeBrowsingManager.updateHashPrefixCache">updateHashPrefixCache</a></td> 177 <td><a href="#SafeBrowsingManager.updateHashPrefixCache">updateHashPrefixCache</a></td>
140 <td>Public method to load or update the locally cached threat lists.</td> 178 <td>Public method to load or update the locally cached threat lists.</td>
141 </tr> 179 </tr>
142 </table> 180 </table>
143 <h3>Static Methods</h3> 181 <h3>Static Methods</h3>
182
144 <table> 183 <table>
145 <tr><td>None</td></tr> 184 <tr><td>None</td></tr>
146 </table> 185 </table>
186
147 <a NAME="SafeBrowsingManager.getIgnoreSchemes" ID="SafeBrowsingManager.getIgnoreSchemes"></a> 187 <a NAME="SafeBrowsingManager.getIgnoreSchemes" ID="SafeBrowsingManager.getIgnoreSchemes"></a>
148 <h4>SafeBrowsingManager.getIgnoreSchemes (class method)</h4> 188 <h4>SafeBrowsingManager.getIgnoreSchemes (class method)</h4>
149 <b>getIgnoreSchemes</b>(<i></i>) 189 <b>getIgnoreSchemes</b>(<i></i>)
190
150 <p> 191 <p>
151 Class method to get the schemes not to be checked. 192 Class method to get the schemes not to be checked.
152 </p><dl> 193 </p>
194 <dl>
153 <dt>Returns:</dt> 195 <dt>Returns:</dt>
154 <dd> 196 <dd>
155 list of schemes to be ignored 197 list of schemes to be ignored
156 </dd> 198 </dd>
157 </dl><dl> 199 </dl>
200 <dl>
158 <dt>Return Type:</dt> 201 <dt>Return Type:</dt>
159 <dd> 202 <dd>
160 list of str 203 list of str
161 </dd> 204 </dd>
162 </dl><a NAME="SafeBrowsingManager.isEnabled" ID="SafeBrowsingManager.isEnabled"></a> 205 </dl>
206 <a NAME="SafeBrowsingManager.isEnabled" ID="SafeBrowsingManager.isEnabled"></a>
163 <h4>SafeBrowsingManager.isEnabled (class method)</h4> 207 <h4>SafeBrowsingManager.isEnabled (class method)</h4>
164 <b>isEnabled</b>(<i></i>) 208 <b>isEnabled</b>(<i></i>)
209
165 <p> 210 <p>
166 Class method to check, if safe browsing is enabled. 211 Class method to check, if safe browsing is enabled.
167 </p><dl> 212 </p>
213 <dl>
168 <dt>Returns:</dt> 214 <dt>Returns:</dt>
169 <dd> 215 <dd>
170 flag indicating the enabled state 216 flag indicating the enabled state
171 </dd> 217 </dd>
172 </dl><dl> 218 </dl>
219 <dl>
173 <dt>Return Type:</dt> 220 <dt>Return Type:</dt>
174 <dd> 221 <dd>
175 bool 222 bool
176 </dd> 223 </dd>
177 </dl><a NAME="SafeBrowsingManager.__init__" ID="SafeBrowsingManager.__init__"></a> 224 </dl>
225 <a NAME="SafeBrowsingManager.__init__" ID="SafeBrowsingManager.__init__"></a>
178 <h4>SafeBrowsingManager (Constructor)</h4> 226 <h4>SafeBrowsingManager (Constructor)</h4>
179 <b>SafeBrowsingManager</b>(<i></i>) 227 <b>SafeBrowsingManager</b>(<i></i>)
228
180 <p> 229 <p>
181 Constructor 230 Constructor
182 </p><a NAME="SafeBrowsingManager.__lookupHashes" ID="SafeBrowsingManager.__lookupHashes"></a> 231 </p>
232 <a NAME="SafeBrowsingManager.__lookupHashes" ID="SafeBrowsingManager.__lookupHashes"></a>
183 <h4>SafeBrowsingManager.__lookupHashes</h4> 233 <h4>SafeBrowsingManager.__lookupHashes</h4>
184 <b>__lookupHashes</b>(<i>fullHashes</i>) 234 <b>__lookupHashes</b>(<i>fullHashes</i>)
235
185 <p> 236 <p>
186 Private method to lookup the given hashes. 237 Private method to lookup the given hashes.
187 </p><dl> 238 </p>
239 <dl>
240
188 <dt><i>fullHashes</i> (list of bytes)</dt> 241 <dt><i>fullHashes</i> (list of bytes)</dt>
189 <dd> 242 <dd>
190 list of hashes to lookup 243 list of hashes to lookup
191 </dd> 244 </dd>
192 </dl><dl> 245 </dl>
246 <dl>
193 <dt>Returns:</dt> 247 <dt>Returns:</dt>
194 <dd> 248 <dd>
195 names of threat lists hashes were found in 249 names of threat lists hashes were found in
196 </dd> 250 </dd>
197 </dl><dl> 251 </dl>
252 <dl>
198 <dt>Return Type:</dt> 253 <dt>Return Type:</dt>
199 <dd> 254 <dd>
200 list of ThreatList 255 list of ThreatList
201 </dd> 256 </dd>
202 </dl><a NAME="SafeBrowsingManager.__setAutoUpdateThreatLists" ID="SafeBrowsingManager.__setAutoUpdateThreatLists"></a> 257 </dl>
258 <a NAME="SafeBrowsingManager.__setAutoUpdateThreatLists" ID="SafeBrowsingManager.__setAutoUpdateThreatLists"></a>
203 <h4>SafeBrowsingManager.__setAutoUpdateThreatLists</h4> 259 <h4>SafeBrowsingManager.__setAutoUpdateThreatLists</h4>
204 <b>__setAutoUpdateThreatLists</b>(<i></i>) 260 <b>__setAutoUpdateThreatLists</b>(<i></i>)
261
205 <p> 262 <p>
206 Private method to set auto update for the threat lists. 263 Private method to set auto update for the threat lists.
207 </p><a NAME="SafeBrowsingManager.__setLookupMethod" ID="SafeBrowsingManager.__setLookupMethod"></a> 264 </p>
265 <a NAME="SafeBrowsingManager.__setLookupMethod" ID="SafeBrowsingManager.__setLookupMethod"></a>
208 <h4>SafeBrowsingManager.__setLookupMethod</h4> 266 <h4>SafeBrowsingManager.__setLookupMethod</h4>
209 <b>__setLookupMethod</b>(<i></i>) 267 <b>__setLookupMethod</b>(<i></i>)
268
210 <p> 269 <p>
211 Private method to set the lookup method (Update API or Lookup API). 270 Private method to set the lookup method (Update API or Lookup API).
212 </p><a NAME="SafeBrowsingManager.__setPlatforms" ID="SafeBrowsingManager.__setPlatforms"></a> 271 </p>
272 <a NAME="SafeBrowsingManager.__setPlatforms" ID="SafeBrowsingManager.__setPlatforms"></a>
213 <h4>SafeBrowsingManager.__setPlatforms</h4> 273 <h4>SafeBrowsingManager.__setPlatforms</h4>
214 <b>__setPlatforms</b>(<i></i>) 274 <b>__setPlatforms</b>(<i></i>)
275
215 <p> 276 <p>
216 Private method to set the platforms to be checked against. 277 Private method to set the platforms to be checked against.
217 </p><a NAME="SafeBrowsingManager.__showNotificationMessage" ID="SafeBrowsingManager.__showNotificationMessage"></a> 278 </p>
279 <a NAME="SafeBrowsingManager.__showNotificationMessage" ID="SafeBrowsingManager.__showNotificationMessage"></a>
218 <h4>SafeBrowsingManager.__showNotificationMessage</h4> 280 <h4>SafeBrowsingManager.__showNotificationMessage</h4>
219 <b>__showNotificationMessage</b>(<i>message, timeout=5</i>) 281 <b>__showNotificationMessage</b>(<i>message, timeout=5</i>)
282
220 <p> 283 <p>
221 Private method to show some message in a notification widget. 284 Private method to show some message in a notification widget.
222 </p><p> 285 </p>
286 <p>
223 If desktop notifications have been disabled, the message will 287 If desktop notifications have been disabled, the message will
224 be shown in the status bar of the main window (either the main 288 be shown in the status bar of the main window (either the main
225 web browser window or the eric main window) 289 web browser window or the eric main window)
226 </p><dl> 290 </p>
291 <dl>
292
227 <dt><i>message</i> (str)</dt> 293 <dt><i>message</i> (str)</dt>
228 <dd> 294 <dd>
229 message to be shown 295 message to be shown
230 </dd><dt><i>timeout</i> (int)</dt> 296 </dd>
297 <dt><i>timeout</i> (int)</dt>
231 <dd> 298 <dd>
232 amount of time in seconds the message should be shown 299 amount of time in seconds the message should be shown
233 (0 = indefinitely) 300 (0 = indefinitely)
234 </dd> 301 </dd>
235 </dl><a NAME="SafeBrowsingManager.__syncFullHashes" ID="SafeBrowsingManager.__syncFullHashes"></a> 302 </dl>
303 <a NAME="SafeBrowsingManager.__syncFullHashes" ID="SafeBrowsingManager.__syncFullHashes"></a>
236 <h4>SafeBrowsingManager.__syncFullHashes</h4> 304 <h4>SafeBrowsingManager.__syncFullHashes</h4>
237 <b>__syncFullHashes</b>(<i>hashPrefixes</i>) 305 <b>__syncFullHashes</b>(<i>hashPrefixes</i>)
306
238 <p> 307 <p>
239 Private method to download full hashes matching given prefixes. 308 Private method to download full hashes matching given prefixes.
240 </p><p> 309 </p>
310 <p>
241 This also updates the cache expiration timestamps. 311 This also updates the cache expiration timestamps.
242 </p><dl> 312 </p>
313 <dl>
314
243 <dt><i>hashPrefixes</i> (list of bytes)</dt> 315 <dt><i>hashPrefixes</i> (list of bytes)</dt>
244 <dd> 316 <dd>
245 list of hash prefixes to get full hashes for 317 list of hash prefixes to get full hashes for
246 </dd> 318 </dd>
247 </dl><a NAME="SafeBrowsingManager.__threatListsUpdateTimerTimeout" ID="SafeBrowsingManager.__threatListsUpdateTimerTimeout"></a> 319 </dl>
320 <a NAME="SafeBrowsingManager.__threatListsUpdateTimerTimeout" ID="SafeBrowsingManager.__threatListsUpdateTimerTimeout"></a>
248 <h4>SafeBrowsingManager.__threatListsUpdateTimerTimeout</h4> 321 <h4>SafeBrowsingManager.__threatListsUpdateTimerTimeout</h4>
249 <b>__threatListsUpdateTimerTimeout</b>(<i></i>) 322 <b>__threatListsUpdateTimerTimeout</b>(<i></i>)
323
250 <p> 324 <p>
251 Private slot to perform the auto update of the threat lists. 325 Private slot to perform the auto update of the threat lists.
252 </p><a NAME="SafeBrowsingManager.__verifyThreatListChecksum" ID="SafeBrowsingManager.__verifyThreatListChecksum"></a> 326 </p>
327 <a NAME="SafeBrowsingManager.__verifyThreatListChecksum" ID="SafeBrowsingManager.__verifyThreatListChecksum"></a>
253 <h4>SafeBrowsingManager.__verifyThreatListChecksum</h4> 328 <h4>SafeBrowsingManager.__verifyThreatListChecksum</h4>
254 <b>__verifyThreatListChecksum</b>(<i>threatList, remoteChecksum</i>) 329 <b>__verifyThreatListChecksum</b>(<i>threatList, remoteChecksum</i>)
330
255 <p> 331 <p>
256 Private method to verify the local checksum of a threat list with the 332 Private method to verify the local checksum of a threat list with the
257 checksum of the safe browsing server. 333 checksum of the safe browsing server.
258 </p><dl> 334 </p>
335 <dl>
336
259 <dt><i>threatList</i> (ThreatList)</dt> 337 <dt><i>threatList</i> (ThreatList)</dt>
260 <dd> 338 <dd>
261 threat list to calculate checksum for 339 threat list to calculate checksum for
262 </dd><dt><i>remoteChecksum</i> (bytes)</dt> 340 </dd>
341 <dt><i>remoteChecksum</i> (bytes)</dt>
263 <dd> 342 <dd>
264 SHA256 checksum as reported by the Google server 343 SHA256 checksum as reported by the Google server
265 </dd> 344 </dd>
266 </dl><dl> 345 </dl>
346 <dl>
267 <dt>Returns:</dt> 347 <dt>Returns:</dt>
268 <dd> 348 <dd>
269 flag indicating equality 349 flag indicating equality
270 </dd> 350 </dd>
271 </dl><dl> 351 </dl>
352 <dl>
272 <dt>Return Type:</dt> 353 <dt>Return Type:</dt>
273 <dd> 354 <dd>
274 bool 355 bool
275 </dd> 356 </dd>
276 </dl><a NAME="SafeBrowsingManager.close" ID="SafeBrowsingManager.close"></a> 357 </dl>
358 <a NAME="SafeBrowsingManager.close" ID="SafeBrowsingManager.close"></a>
277 <h4>SafeBrowsingManager.close</h4> 359 <h4>SafeBrowsingManager.close</h4>
278 <b>close</b>(<i></i>) 360 <b>close</b>(<i></i>)
361
279 <p> 362 <p>
280 Public method to close the safe browsing interface. 363 Public method to close the safe browsing interface.
281 </p><a NAME="SafeBrowsingManager.configurationChanged" ID="SafeBrowsingManager.configurationChanged"></a> 364 </p>
365 <a NAME="SafeBrowsingManager.configurationChanged" ID="SafeBrowsingManager.configurationChanged"></a>
282 <h4>SafeBrowsingManager.configurationChanged</h4> 366 <h4>SafeBrowsingManager.configurationChanged</h4>
283 <b>configurationChanged</b>(<i></i>) 367 <b>configurationChanged</b>(<i></i>)
368
284 <p> 369 <p>
285 Public method to handle changes of the settings. 370 Public method to handle changes of the settings.
286 </p><a NAME="SafeBrowsingManager.fairUseDelayExpired" ID="SafeBrowsingManager.fairUseDelayExpired"></a> 371 </p>
372 <a NAME="SafeBrowsingManager.fairUseDelayExpired" ID="SafeBrowsingManager.fairUseDelayExpired"></a>
287 <h4>SafeBrowsingManager.fairUseDelayExpired</h4> 373 <h4>SafeBrowsingManager.fairUseDelayExpired</h4>
288 <b>fairUseDelayExpired</b>(<i></i>) 374 <b>fairUseDelayExpired</b>(<i></i>)
375
289 <p> 376 <p>
290 Public method to check, if the fair use wait period has expired. 377 Public method to check, if the fair use wait period has expired.
291 </p><dl> 378 </p>
379 <dl>
292 <dt>Returns:</dt> 380 <dt>Returns:</dt>
293 <dd> 381 <dd>
294 flag indicating expiration 382 flag indicating expiration
295 </dd> 383 </dd>
296 </dl><dl> 384 </dl>
385 <dl>
297 <dt>Return Type:</dt> 386 <dt>Return Type:</dt>
298 <dd> 387 <dd>
299 bool 388 bool
300 </dd> 389 </dd>
301 </dl><a NAME="SafeBrowsingManager.fullCacheCleanup" ID="SafeBrowsingManager.fullCacheCleanup"></a> 390 </dl>
391 <a NAME="SafeBrowsingManager.fullCacheCleanup" ID="SafeBrowsingManager.fullCacheCleanup"></a>
302 <h4>SafeBrowsingManager.fullCacheCleanup</h4> 392 <h4>SafeBrowsingManager.fullCacheCleanup</h4>
303 <b>fullCacheCleanup</b>(<i></i>) 393 <b>fullCacheCleanup</b>(<i></i>)
394
304 <p> 395 <p>
305 Public method to clean up the cache completely. 396 Public method to clean up the cache completely.
306 </p><a NAME="SafeBrowsingManager.getPlatformString" ID="SafeBrowsingManager.getPlatformString"></a> 397 </p>
398 <a NAME="SafeBrowsingManager.getPlatformString" ID="SafeBrowsingManager.getPlatformString"></a>
307 <h4>SafeBrowsingManager.getPlatformString</h4> 399 <h4>SafeBrowsingManager.getPlatformString</h4>
308 <b>getPlatformString</b>(<i>platformType</i>) 400 <b>getPlatformString</b>(<i>platformType</i>)
401
309 <p> 402 <p>
310 Public method to get the platform string for a given platform type. 403 Public method to get the platform string for a given platform type.
311 </p><dl> 404 </p>
405 <dl>
406
312 <dt><i>platformType</i> (str)</dt> 407 <dt><i>platformType</i> (str)</dt>
313 <dd> 408 <dd>
314 platform type as defined in the v4 API 409 platform type as defined in the v4 API
315 </dd> 410 </dd>
316 </dl><dl> 411 </dl>
412 <dl>
317 <dt>Returns:</dt> 413 <dt>Returns:</dt>
318 <dd> 414 <dd>
319 platform string 415 platform string
320 </dd> 416 </dd>
321 </dl><dl> 417 </dl>
418 <dl>
322 <dt>Return Type:</dt> 419 <dt>Return Type:</dt>
323 <dd> 420 <dd>
324 str 421 str
325 </dd> 422 </dd>
326 </dl><a NAME="SafeBrowsingManager.getThreatEntryString" ID="SafeBrowsingManager.getThreatEntryString"></a> 423 </dl>
424 <a NAME="SafeBrowsingManager.getThreatEntryString" ID="SafeBrowsingManager.getThreatEntryString"></a>
327 <h4>SafeBrowsingManager.getThreatEntryString</h4> 425 <h4>SafeBrowsingManager.getThreatEntryString</h4>
328 <b>getThreatEntryString</b>(<i>threatEntry</i>) 426 <b>getThreatEntryString</b>(<i>threatEntry</i>)
427
329 <p> 428 <p>
330 Public method to get the threat entry string. 429 Public method to get the threat entry string.
331 </p><dl> 430 </p>
431 <dl>
432
332 <dt><i>threatEntry</i> (str)</dt> 433 <dt><i>threatEntry</i> (str)</dt>
333 <dd> 434 <dd>
334 threat entry type as defined in the v4 API 435 threat entry type as defined in the v4 API
335 </dd> 436 </dd>
336 </dl><dl> 437 </dl>
438 <dl>
337 <dt>Returns:</dt> 439 <dt>Returns:</dt>
338 <dd> 440 <dd>
339 threat entry string 441 threat entry string
340 </dd> 442 </dd>
341 </dl><dl> 443 </dl>
444 <dl>
342 <dt>Return Type:</dt> 445 <dt>Return Type:</dt>
343 <dd> 446 <dd>
344 str 447 str
345 </dd> 448 </dd>
346 </dl><a NAME="SafeBrowsingManager.getThreatMessage" ID="SafeBrowsingManager.getThreatMessage"></a> 449 </dl>
450 <a NAME="SafeBrowsingManager.getThreatMessage" ID="SafeBrowsingManager.getThreatMessage"></a>
347 <h4>SafeBrowsingManager.getThreatMessage</h4> 451 <h4>SafeBrowsingManager.getThreatMessage</h4>
348 <b>getThreatMessage</b>(<i>threatType</i>) 452 <b>getThreatMessage</b>(<i>threatType</i>)
453
349 <p> 454 <p>
350 Public method to get a warning message for the given threat type. 455 Public method to get a warning message for the given threat type.
351 </p><dl> 456 </p>
457 <dl>
458
352 <dt><i>threatType</i> (str)</dt> 459 <dt><i>threatType</i> (str)</dt>
353 <dd> 460 <dd>
354 threat type to get the message for 461 threat type to get the message for
355 </dd> 462 </dd>
356 </dl><dl> 463 </dl>
464 <dl>
357 <dt>Returns:</dt> 465 <dt>Returns:</dt>
358 <dd> 466 <dd>
359 threat message 467 threat message
360 </dd> 468 </dd>
361 </dl><dl> 469 </dl>
470 <dl>
362 <dt>Return Type:</dt> 471 <dt>Return Type:</dt>
363 <dd> 472 <dd>
364 str 473 str
365 </dd> 474 </dd>
366 </dl><a NAME="SafeBrowsingManager.getThreatMessages" ID="SafeBrowsingManager.getThreatMessages"></a> 475 </dl>
476 <a NAME="SafeBrowsingManager.getThreatMessages" ID="SafeBrowsingManager.getThreatMessages"></a>
367 <h4>SafeBrowsingManager.getThreatMessages</h4> 477 <h4>SafeBrowsingManager.getThreatMessages</h4>
368 <b>getThreatMessages</b>(<i>threatLists</i>) 478 <b>getThreatMessages</b>(<i>threatLists</i>)
479
369 <p> 480 <p>
370 Public method to get threat messages for the given threats. 481 Public method to get threat messages for the given threats.
371 </p><dl> 482 </p>
483 <dl>
484
372 <dt><i>threatLists</i> (list of ThreatList)</dt> 485 <dt><i>threatLists</i> (list of ThreatList)</dt>
373 <dd> 486 <dd>
374 list of threat lists to get a message for 487 list of threat lists to get a message for
375 </dd> 488 </dd>
376 </dl><dl> 489 </dl>
490 <dl>
377 <dt>Returns:</dt> 491 <dt>Returns:</dt>
378 <dd> 492 <dd>
379 list of threat messages, one per unique threat type 493 list of threat messages, one per unique threat type
380 </dd> 494 </dd>
381 </dl><dl> 495 </dl>
496 <dl>
382 <dt>Return Type:</dt> 497 <dt>Return Type:</dt>
383 <dd> 498 <dd>
384 list of str 499 list of str
385 </dd> 500 </dd>
386 </dl><a NAME="SafeBrowsingManager.getThreatType" ID="SafeBrowsingManager.getThreatType"></a> 501 </dl>
502 <a NAME="SafeBrowsingManager.getThreatType" ID="SafeBrowsingManager.getThreatType"></a>
387 <h4>SafeBrowsingManager.getThreatType</h4> 503 <h4>SafeBrowsingManager.getThreatType</h4>
388 <b>getThreatType</b>(<i>threatList</i>) 504 <b>getThreatType</b>(<i>threatList</i>)
505
389 <p> 506 <p>
390 Public method to get a display string for a given threat type. 507 Public method to get a display string for a given threat type.
391 </p><dl> 508 </p>
509 <dl>
510
392 <dt><i>threatList</i> (str)</dt> 511 <dt><i>threatList</i> (str)</dt>
393 <dd> 512 <dd>
394 threat list to get display string for 513 threat list to get display string for
395 </dd> 514 </dd>
396 </dl><dl> 515 </dl>
516 <dl>
397 <dt>Returns:</dt> 517 <dt>Returns:</dt>
398 <dd> 518 <dd>
399 display string 519 display string
400 </dd> 520 </dd>
401 </dl><dl> 521 </dl>
522 <dl>
402 <dt>Return Type:</dt> 523 <dt>Return Type:</dt>
403 <dd> 524 <dd>
404 str 525 str
405 </dd> 526 </dd>
406 </dl><a NAME="SafeBrowsingManager.isUpdatingThreatLists" ID="SafeBrowsingManager.isUpdatingThreatLists"></a> 527 </dl>
528 <a NAME="SafeBrowsingManager.isUpdatingThreatLists" ID="SafeBrowsingManager.isUpdatingThreatLists"></a>
407 <h4>SafeBrowsingManager.isUpdatingThreatLists</h4> 529 <h4>SafeBrowsingManager.isUpdatingThreatLists</h4>
408 <b>isUpdatingThreatLists</b>(<i></i>) 530 <b>isUpdatingThreatLists</b>(<i></i>)
531
409 <p> 532 <p>
410 Public method to check, if we are in the process of updating the 533 Public method to check, if we are in the process of updating the
411 threat lists. 534 threat lists.
412 </p><dl> 535 </p>
536 <dl>
413 <dt>Returns:</dt> 537 <dt>Returns:</dt>
414 <dd> 538 <dd>
415 flag indicating an update process is active 539 flag indicating an update process is active
416 </dd> 540 </dd>
417 </dl><dl> 541 </dl>
542 <dl>
418 <dt>Return Type:</dt> 543 <dt>Return Type:</dt>
419 <dd> 544 <dd>
420 bool 545 bool
421 </dd> 546 </dd>
422 </dl><a NAME="SafeBrowsingManager.lookupUrl" ID="SafeBrowsingManager.lookupUrl"></a> 547 </dl>
548 <a NAME="SafeBrowsingManager.lookupUrl" ID="SafeBrowsingManager.lookupUrl"></a>
423 <h4>SafeBrowsingManager.lookupUrl</h4> 549 <h4>SafeBrowsingManager.lookupUrl</h4>
424 <b>lookupUrl</b>(<i>url</i>) 550 <b>lookupUrl</b>(<i>url</i>)
551
425 <p> 552 <p>
426 Public method to lookup an URL. 553 Public method to lookup an URL.
427 </p><dl> 554 </p>
555 <dl>
556
428 <dt><i>url</i> (str or QUrl)</dt> 557 <dt><i>url</i> (str or QUrl)</dt>
429 <dd> 558 <dd>
430 URL to be checked 559 URL to be checked
431 </dd> 560 </dd>
432 </dl><dl> 561 </dl>
562 <dl>
433 <dt>Returns:</dt> 563 <dt>Returns:</dt>
434 <dd> 564 <dd>
435 tuple containing the list of threat lists the URL was found in 565 tuple containing the list of threat lists the URL was found in
436 and an error message 566 and an error message
437 </dd> 567 </dd>
438 </dl><dl> 568 </dl>
569 <dl>
439 <dt>Return Type:</dt> 570 <dt>Return Type:</dt>
440 <dd> 571 <dd>
441 tuple of (list of ThreatList, str) 572 tuple of (list of ThreatList, str)
442 </dd> 573 </dd>
443 </dl><dl> 574 </dl>
575 <dl>
576
444 <dt>Raises <b>ValueError</b>:</dt> 577 <dt>Raises <b>ValueError</b>:</dt>
445 <dd> 578 <dd>
446 raised for an invalid URL 579 raised for an invalid URL
447 </dd> 580 </dd>
448 </dl><a NAME="SafeBrowsingManager.showSafeBrowsingDialog" ID="SafeBrowsingManager.showSafeBrowsingDialog"></a> 581 </dl>
582 <a NAME="SafeBrowsingManager.showSafeBrowsingDialog" ID="SafeBrowsingManager.showSafeBrowsingDialog"></a>
449 <h4>SafeBrowsingManager.showSafeBrowsingDialog</h4> 583 <h4>SafeBrowsingManager.showSafeBrowsingDialog</h4>
450 <b>showSafeBrowsingDialog</b>(<i></i>) 584 <b>showSafeBrowsingDialog</b>(<i></i>)
585
451 <p> 586 <p>
452 Public slot to show the safe browsing management dialog. 587 Public slot to show the safe browsing management dialog.
453 </p><a NAME="SafeBrowsingManager.updateHashPrefixCache" ID="SafeBrowsingManager.updateHashPrefixCache"></a> 588 </p>
589 <a NAME="SafeBrowsingManager.updateHashPrefixCache" ID="SafeBrowsingManager.updateHashPrefixCache"></a>
454 <h4>SafeBrowsingManager.updateHashPrefixCache</h4> 590 <h4>SafeBrowsingManager.updateHashPrefixCache</h4>
455 <b>updateHashPrefixCache</b>(<i></i>) 591 <b>updateHashPrefixCache</b>(<i></i>)
592
456 <p> 593 <p>
457 Public method to load or update the locally cached threat lists. 594 Public method to load or update the locally cached threat lists.
458 </p><dl> 595 </p>
596 <dl>
459 <dt>Returns:</dt> 597 <dt>Returns:</dt>
460 <dd> 598 <dd>
461 flag indicating success and an error message 599 flag indicating success and an error message
462 </dd> 600 </dd>
463 </dl><dl> 601 </dl>
602 <dl>
464 <dt>Return Type:</dt> 603 <dt>Return Type:</dt>
465 <dd> 604 <dd>
466 tuple of (bool, str) 605 tuple of (bool, str)
467 </dd> 606 </dd>
468 </dl> 607 </dl>

Mercurial Repository: eric

eric ide

mercurial