Documentation/Source/eric6.Helpviewer.Network.FtpAccessHandler.html

changeset 3673
e26d7d0c1088
equal deleted inserted replaced
3670:f0cb7579c0b4 3673:e26d7d0c1088
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.Helpviewer.Network.FtpAccessHandler</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.Network.FtpAccessHandler</h1>
23 <p>
24 Module implementing a scheme access handler for FTP.
25 </p>
26 <h3>Global Attributes</h3>
27 <table>
28 <tr><td>None</td></tr>
29 </table>
30 <h3>Classes</h3>
31 <table>
32 <tr>
33 <td><a href="#FtpAccessHandler">FtpAccessHandler</a></td>
34 <td>Class implementing a scheme access handler for FTP.</td>
35 </tr>
36 </table>
37 <h3>Functions</h3>
38 <table>
39 <tr><td>None</td></tr>
40 </table>
41 <hr /><hr />
42 <a NAME="FtpAccessHandler" ID="FtpAccessHandler"></a>
43 <h2>FtpAccessHandler</h2>
44 <p>
45 Class implementing a scheme access handler for FTP.
46 </p>
47 <h3>Derived from</h3>
48 SchemeAccessHandler
49 <h3>Class Attributes</h3>
50 <table>
51 <tr><td>None</td></tr>
52 </table>
53 <h3>Class Methods</h3>
54 <table>
55 <tr><td>None</td></tr>
56 </table>
57 <h3>Methods</h3>
58 <table>
59 <tr>
60 <td><a href="#FtpAccessHandler.__init__">FtpAccessHandler</a></td>
61 <td>Constructor</td>
62 </tr><tr>
63 <td><a href="#FtpAccessHandler.createRequest">createRequest</a></td>
64 <td>Public method to create a request.</td>
65 </tr><tr>
66 <td><a href="#FtpAccessHandler.getAuthenticator">getAuthenticator</a></td>
67 <td>Public method to get an authenticator for the given realm.</td>
68 </tr><tr>
69 <td><a href="#FtpAccessHandler.getProxyAuthenticator">getProxyAuthenticator</a></td>
70 <td>Public method to get the authenticator for the FTP proxy.</td>
71 </tr><tr>
72 <td><a href="#FtpAccessHandler.setAuthenticator">setAuthenticator</a></td>
73 <td>Public method to add or change an authenticator in our cache.</td>
74 </tr><tr>
75 <td><a href="#FtpAccessHandler.setProxyAuthenticator">setProxyAuthenticator</a></td>
76 <td>Public method to add or change the authenticator for the FTP proxy.</td>
77 </tr>
78 </table>
79 <h3>Static Methods</h3>
80 <table>
81 <tr><td>None</td></tr>
82 </table>
83 <a NAME="FtpAccessHandler.__init__" ID="FtpAccessHandler.__init__"></a>
84 <h4>FtpAccessHandler (Constructor)</h4>
85 <b>FtpAccessHandler</b>(<i>parent=None</i>)
86 <p>
87 Constructor
88 </p><dl>
89 <dt><i>parent</i></dt>
90 <dd>
91 reference to the parent object (QObject)
92 </dd>
93 </dl><a NAME="FtpAccessHandler.createRequest" ID="FtpAccessHandler.createRequest"></a>
94 <h4>FtpAccessHandler.createRequest</h4>
95 <b>createRequest</b>(<i>op, request, outgoingData=None</i>)
96 <p>
97 Public method to create a request.
98 </p><dl>
99 <dt><i>op</i></dt>
100 <dd>
101 the operation to be performed
102 (QNetworkAccessManager.Operation)
103 </dd><dt><i>request</i></dt>
104 <dd>
105 reference to the request object (QNetworkRequest)
106 </dd><dt><i>outgoingData</i></dt>
107 <dd>
108 reference to an IODevice containing data to be sent
109 (QIODevice)
110 </dd>
111 </dl><dl>
112 <dt>Returns:</dt>
113 <dd>
114 reference to the created reply object (QNetworkReply)
115 </dd>
116 </dl><a NAME="FtpAccessHandler.getAuthenticator" ID="FtpAccessHandler.getAuthenticator"></a>
117 <h4>FtpAccessHandler.getAuthenticator</h4>
118 <b>getAuthenticator</b>(<i>realm</i>)
119 <p>
120 Public method to get an authenticator for the given realm.
121 </p><dl>
122 <dt><i>realm</i></dt>
123 <dd>
124 name of the realm to get the authenticator for (string)
125 </dd>
126 </dl><dl>
127 <dt>Returns:</dt>
128 <dd>
129 authenticator for the given realm (QAuthenticator) or None
130 </dd>
131 </dl><a NAME="FtpAccessHandler.getProxyAuthenticator" ID="FtpAccessHandler.getProxyAuthenticator"></a>
132 <h4>FtpAccessHandler.getProxyAuthenticator</h4>
133 <b>getProxyAuthenticator</b>(<i></i>)
134 <p>
135 Public method to get the authenticator for the FTP proxy.
136 </p><dl>
137 <dt>Returns:</dt>
138 <dd>
139 authenticator for the FTP proxy (QAuthenticator)
140 </dd>
141 </dl><a NAME="FtpAccessHandler.setAuthenticator" ID="FtpAccessHandler.setAuthenticator"></a>
142 <h4>FtpAccessHandler.setAuthenticator</h4>
143 <b>setAuthenticator</b>(<i>realm, authenticator</i>)
144 <p>
145 Public method to add or change an authenticator in our cache.
146 </p><dl>
147 <dt><i>realm</i></dt>
148 <dd>
149 name of the realm the authenticator belongs to (string)
150 </dd><dt><i>authenticator</i></dt>
151 <dd>
152 authenticator to add to the cache
153 (QAuthenticator). If it is None, the entry will be deleted from
154 the cache.
155 </dd>
156 </dl><a NAME="FtpAccessHandler.setProxyAuthenticator" ID="FtpAccessHandler.setProxyAuthenticator"></a>
157 <h4>FtpAccessHandler.setProxyAuthenticator</h4>
158 <b>setProxyAuthenticator</b>(<i>authenticator</i>)
159 <p>
160 Public method to add or change the authenticator for the FTP proxy.
161 </p><dl>
162 <dt><i>authenticator</i></dt>
163 <dd>
164 authenticator for the FTP proxy (QAuthenticator)
165 </dd>
166 </dl>
167 <div align="right"><a href="#top">Up</a></div>
168 <hr />
169 </body></html>

eric ide

mercurial