src/eric7/Documentation/Source/eric7.WebBrowser.Network.NetworkManager.html

branch
eric7
changeset 9209
b99e7fd55fd3
parent 8596
d64760b2da50
child 9503
ae9232bf4854
equal deleted inserted replaced
9208:3fc8dfeb6ebe 9209:b99e7fd55fd3
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric7.WebBrowser.Network.NetworkManager</title>
4 <meta charset="UTF-8">
5 <link rel="stylesheet" href="styles.css">
6 </head>
7 <body>
8 <a NAME="top" ID="top"></a>
9 <h1>eric7.WebBrowser.Network.NetworkManager</h1>
10
11 <p>
12 Module implementing a network manager class.
13 </p>
14 <h3>Global Attributes</h3>
15
16 <table>
17 <tr><td>None</td></tr>
18 </table>
19 <h3>Classes</h3>
20
21 <table>
22
23 <tr>
24 <td><a href="#NetworkManager">NetworkManager</a></td>
25 <td>Class implementing a network manager.</td>
26 </tr>
27 </table>
28 <h3>Functions</h3>
29
30 <table>
31 <tr><td>None</td></tr>
32 </table>
33 <hr />
34 <hr />
35 <a NAME="NetworkManager" ID="NetworkManager"></a>
36 <h2>NetworkManager</h2>
37
38 <p>
39 Class implementing a network manager.
40 </p>
41 <h3>Signals</h3>
42 <dl>
43
44 <dt>changed()</dt>
45 <dd>
46 emitted to indicate a change
47 </dd>
48 </dl>
49 <h3>Derived from</h3>
50 QNetworkAccessManager
51 <h3>Class Attributes</h3>
52
53 <table>
54 <tr><td>None</td></tr>
55 </table>
56 <h3>Class Methods</h3>
57
58 <table>
59 <tr><td>None</td></tr>
60 </table>
61 <h3>Methods</h3>
62
63 <table>
64
65 <tr>
66 <td><a href="#NetworkManager.__init__">NetworkManager</a></td>
67 <td>Constructor</td>
68 </tr>
69 <tr>
70 <td><a href="#NetworkManager.__load">__load</a></td>
71 <td>Private method to load the permanent SSL error exceptions.</td>
72 </tr>
73 <tr>
74 <td><a href="#NetworkManager.__save">__save</a></td>
75 <td>Private slot to save the permanent SSL error exceptions.</td>
76 </tr>
77 <tr>
78 <td><a href="#NetworkManager.__showAuthenticationErrorPage">__showAuthenticationErrorPage</a></td>
79 <td>Private method to show an authentication error page.</td>
80 </tr>
81 <tr>
82 <td><a href="#NetworkManager.__sslErrorHandlingSlot">__sslErrorHandlingSlot</a></td>
83 <td>Private slot to handle SSL errors for a network reply.</td>
84 </tr>
85 <tr>
86 <td><a href="#NetworkManager.authentication">authentication</a></td>
87 <td>Public slot to handle an authentication request.</td>
88 </tr>
89 <tr>
90 <td><a href="#NetworkManager.certificateError">certificateError</a></td>
91 <td>Public method to handle SSL certificate errors.</td>
92 </tr>
93 <tr>
94 <td><a href="#NetworkManager.clearSslExceptions">clearSslExceptions</a></td>
95 <td>Public method to clear the permanent SSL certificate error exceptions.</td>
96 </tr>
97 <tr>
98 <td><a href="#NetworkManager.createRequest">createRequest</a></td>
99 <td>Public method to launch a network action.</td>
100 </tr>
101 <tr>
102 <td><a href="#NetworkManager.installUrlInterceptor">installUrlInterceptor</a></td>
103 <td>Public method to install an URL interceptor.</td>
104 </tr>
105 <tr>
106 <td><a href="#NetworkManager.isInsecureHost">isInsecureHost</a></td>
107 <td>Public method to check a host against the list of insecure hosts.</td>
108 </tr>
109 <tr>
110 <td><a href="#NetworkManager.languagesChanged">languagesChanged</a></td>
111 <td>Public slot to (re-)load the list of accepted languages.</td>
112 </tr>
113 <tr>
114 <td><a href="#NetworkManager.preferencesChanged">preferencesChanged</a></td>
115 <td>Public slot to handle a change of preferences.</td>
116 </tr>
117 <tr>
118 <td><a href="#NetworkManager.proxyAuthentication">proxyAuthentication</a></td>
119 <td>Public slot to handle a proxy authentication request.</td>
120 </tr>
121 <tr>
122 <td><a href="#NetworkManager.removeUrlInterceptor">removeUrlInterceptor</a></td>
123 <td>Public method to remove an URL interceptor.</td>
124 </tr>
125 <tr>
126 <td><a href="#NetworkManager.showSslErrorExceptionsDialog">showSslErrorExceptionsDialog</a></td>
127 <td>Public method to show the SSL error exceptions dialog.</td>
128 </tr>
129 <tr>
130 <td><a href="#NetworkManager.shutdown">shutdown</a></td>
131 <td>Public method to shut down the network manager.</td>
132 </tr>
133 </table>
134 <h3>Static Methods</h3>
135
136 <table>
137 <tr><td>None</td></tr>
138 </table>
139
140 <a NAME="NetworkManager.__init__" ID="NetworkManager.__init__"></a>
141 <h4>NetworkManager (Constructor)</h4>
142 <b>NetworkManager</b>(<i>engine, parent=None</i>)
143
144 <p>
145 Constructor
146 </p>
147 <dl>
148
149 <dt><i>engine</i></dt>
150 <dd>
151 reference to the help engine (QHelpEngine)
152 </dd>
153 <dt><i>parent</i></dt>
154 <dd>
155 reference to the parent object (QObject)
156 </dd>
157 </dl>
158 <a NAME="NetworkManager.__load" ID="NetworkManager.__load"></a>
159 <h4>NetworkManager.__load</h4>
160 <b>__load</b>(<i></i>)
161
162 <p>
163 Private method to load the permanent SSL error exceptions.
164 </p>
165 <a NAME="NetworkManager.__save" ID="NetworkManager.__save"></a>
166 <h4>NetworkManager.__save</h4>
167 <b>__save</b>(<i></i>)
168
169 <p>
170 Private slot to save the permanent SSL error exceptions.
171 </p>
172 <a NAME="NetworkManager.__showAuthenticationErrorPage" ID="NetworkManager.__showAuthenticationErrorPage"></a>
173 <h4>NetworkManager.__showAuthenticationErrorPage</h4>
174 <b>__showAuthenticationErrorPage</b>(<i>page, url</i>)
175
176 <p>
177 Private method to show an authentication error page.
178 </p>
179 <dl>
180
181 <dt><i>page</i> (QWebEnginePage)</dt>
182 <dd>
183 reference to the page
184 </dd>
185 <dt><i>url</i> (QUrl)</dt>
186 <dd>
187 reference to the URL requesting authentication
188 </dd>
189 </dl>
190 <a NAME="NetworkManager.__sslErrorHandlingSlot" ID="NetworkManager.__sslErrorHandlingSlot"></a>
191 <h4>NetworkManager.__sslErrorHandlingSlot</h4>
192 <b>__sslErrorHandlingSlot</b>(<i>reply, errors</i>)
193
194 <p>
195 Private slot to handle SSL errors for a network reply.
196 </p>
197 <dl>
198
199 <dt><i>reply</i> (QNetworkReply)</dt>
200 <dd>
201 reference to the reply object
202 </dd>
203 <dt><i>errors</i> (list of QSslError)</dt>
204 <dd>
205 list of SSL errors
206 </dd>
207 </dl>
208 <a NAME="NetworkManager.authentication" ID="NetworkManager.authentication"></a>
209 <h4>NetworkManager.authentication</h4>
210 <b>authentication</b>(<i>url, auth, page=None</i>)
211
212 <p>
213 Public slot to handle an authentication request.
214 </p>
215 <dl>
216
217 <dt><i>url</i> (QUrl)</dt>
218 <dd>
219 URL requesting authentication
220 </dd>
221 <dt><i>auth</i> (QAuthenticator)</dt>
222 <dd>
223 reference to the authenticator object
224 </dd>
225 <dt><i>page</i> (QWebEnginePage or None)</dt>
226 <dd>
227 reference to the web page
228 </dd>
229 </dl>
230 <a NAME="NetworkManager.certificateError" ID="NetworkManager.certificateError"></a>
231 <h4>NetworkManager.certificateError</h4>
232 <b>certificateError</b>(<i>error, view</i>)
233
234 <p>
235 Public method to handle SSL certificate errors.
236 </p>
237 <dl>
238
239 <dt><i>error</i> (QWebEngineCertificateError)</dt>
240 <dd>
241 object containing the certificate error information
242 </dd>
243 <dt><i>view</i> (QWidget)</dt>
244 <dd>
245 reference to a view to be used as parent for the dialog
246 </dd>
247 </dl>
248 <dl>
249 <dt>Return:</dt>
250 <dd>
251 flag indicating to ignore this error
252 </dd>
253 </dl>
254 <dl>
255 <dt>Return Type:</dt>
256 <dd>
257 bool
258 </dd>
259 </dl>
260 <a NAME="NetworkManager.clearSslExceptions" ID="NetworkManager.clearSslExceptions"></a>
261 <h4>NetworkManager.clearSslExceptions</h4>
262 <b>clearSslExceptions</b>(<i></i>)
263
264 <p>
265 Public method to clear the permanent SSL certificate error exceptions.
266 </p>
267 <a NAME="NetworkManager.createRequest" ID="NetworkManager.createRequest"></a>
268 <h4>NetworkManager.createRequest</h4>
269 <b>createRequest</b>(<i>op, request, data</i>)
270
271 <p>
272 Public method to launch a network action.
273 </p>
274 <dl>
275
276 <dt><i>op</i> (QNetworkAccessManager.Operation)</dt>
277 <dd>
278 operation to be performed
279 </dd>
280 <dt><i>request</i> (QNetworkRequest)</dt>
281 <dd>
282 request to be operated on
283 </dd>
284 <dt><i>data</i> (QIODevice)</dt>
285 <dd>
286 reference to the data to be sent
287 </dd>
288 </dl>
289 <dl>
290 <dt>Return:</dt>
291 <dd>
292 reference to the network reply
293 </dd>
294 </dl>
295 <dl>
296 <dt>Return Type:</dt>
297 <dd>
298 QNetworkReply
299 </dd>
300 </dl>
301 <a NAME="NetworkManager.installUrlInterceptor" ID="NetworkManager.installUrlInterceptor"></a>
302 <h4>NetworkManager.installUrlInterceptor</h4>
303 <b>installUrlInterceptor</b>(<i>interceptor</i>)
304
305 <p>
306 Public method to install an URL interceptor.
307 </p>
308 <dl>
309
310 <dt><i>interceptor</i> (UrlInterceptor)</dt>
311 <dd>
312 URL interceptor to be installed
313 </dd>
314 </dl>
315 <a NAME="NetworkManager.isInsecureHost" ID="NetworkManager.isInsecureHost"></a>
316 <h4>NetworkManager.isInsecureHost</h4>
317 <b>isInsecureHost</b>(<i>host</i>)
318
319 <p>
320 Public method to check a host against the list of insecure hosts.
321 </p>
322 <dl>
323
324 <dt><i>host</i> (str)</dt>
325 <dd>
326 name of the host to be checked
327 </dd>
328 </dl>
329 <dl>
330 <dt>Return:</dt>
331 <dd>
332 flag indicating an insecure host
333 </dd>
334 </dl>
335 <dl>
336 <dt>Return Type:</dt>
337 <dd>
338 bool
339 </dd>
340 </dl>
341 <a NAME="NetworkManager.languagesChanged" ID="NetworkManager.languagesChanged"></a>
342 <h4>NetworkManager.languagesChanged</h4>
343 <b>languagesChanged</b>(<i></i>)
344
345 <p>
346 Public slot to (re-)load the list of accepted languages.
347 </p>
348 <a NAME="NetworkManager.preferencesChanged" ID="NetworkManager.preferencesChanged"></a>
349 <h4>NetworkManager.preferencesChanged</h4>
350 <b>preferencesChanged</b>(<i></i>)
351
352 <p>
353 Public slot to handle a change of preferences.
354 </p>
355 <a NAME="NetworkManager.proxyAuthentication" ID="NetworkManager.proxyAuthentication"></a>
356 <h4>NetworkManager.proxyAuthentication</h4>
357 <b>proxyAuthentication</b>(<i>requestUrl, auth, proxyHost</i>)
358
359 <p>
360 Public slot to handle a proxy authentication request.
361 </p>
362 <dl>
363
364 <dt><i>requestUrl</i> (QUrl)</dt>
365 <dd>
366 requested URL
367 </dd>
368 <dt><i>auth</i> (QAuthenticator)</dt>
369 <dd>
370 reference to the authenticator object
371 </dd>
372 <dt><i>proxyHost</i> (str)</dt>
373 <dd>
374 name of the proxy host
375 </dd>
376 </dl>
377 <a NAME="NetworkManager.removeUrlInterceptor" ID="NetworkManager.removeUrlInterceptor"></a>
378 <h4>NetworkManager.removeUrlInterceptor</h4>
379 <b>removeUrlInterceptor</b>(<i>interceptor</i>)
380
381 <p>
382 Public method to remove an URL interceptor.
383 </p>
384 <dl>
385
386 <dt><i>interceptor</i> (UrlInterceptor)</dt>
387 <dd>
388 URL interceptor to be removed
389 </dd>
390 </dl>
391 <a NAME="NetworkManager.showSslErrorExceptionsDialog" ID="NetworkManager.showSslErrorExceptionsDialog"></a>
392 <h4>NetworkManager.showSslErrorExceptionsDialog</h4>
393 <b>showSslErrorExceptionsDialog</b>(<i></i>)
394
395 <p>
396 Public method to show the SSL error exceptions dialog.
397 </p>
398 <a NAME="NetworkManager.shutdown" ID="NetworkManager.shutdown"></a>
399 <h4>NetworkManager.shutdown</h4>
400 <b>shutdown</b>(<i></i>)
401
402 <p>
403 Public method to shut down the network manager.
404 </p>
405 <div align="right"><a href="#top">Up</a></div>
406 <hr />
407 </body></html>

eric ide

mercurial