Mercurial Repositories > eric / file comparison
comparison: src/eric7/Documentation/Source/eric7.WebBrowser.Sync.FtpSyncHandler.html
src/eric7/Documentation/Source/eric7.WebBrowser.Sync.FtpSyncHandler.html
- branch
- eric7
- changeset 10436
- f6881d10e995
- parent 9209
- b99e7fd55fd3
- child 10479
- 856476537696
equal
deleted
inserted
replaced
| 10435:c712d09cc839 | 10436:f6881d10e995 |
|---|---|
| 41 <h3>Signals</h3> | 41 <h3>Signals</h3> |
| 42 <dl> | 42 <dl> |
| 43 | 43 |
| 44 <dt>syncError(message)</dt> | 44 <dt>syncError(message)</dt> |
| 45 <dd> | 45 <dd> |
| 46 emitted for a general error with the error | 46 emitted for a general error with the error message |
| 47 message (string) | |
| 48 </dd> | 47 </dd> |
| 49 <dt>syncFinished(type_, done, download)</dt> | 48 <dt>syncFinished(type_, done, download)</dt> |
| 50 <dd> | 49 <dd> |
| 51 emitted after a | 50 emitted after a synchronization |
| 52 synchronization has finished (string one of "bookmarks", "history", | 51 has finished |
| 53 "passwords", "useragents" or "speeddial", boolean, boolean) | |
| 54 </dd> | 52 </dd> |
| 55 <dt>syncMessage(message)</dt> | 53 <dt>syncMessage(message)</dt> |
| 56 <dd> | 54 <dd> |
| 57 emitted to send a message about | 55 emitted to send a message about synchronization |
| 58 synchronization (string) | |
| 59 </dd> | 56 </dd> |
| 60 <dt>syncStatus(type_, message)</dt> | 57 <dt>syncStatus(type_, message)</dt> |
| 61 <dd> | 58 <dd> |
| 62 emitted to indicate the synchronization | 59 emitted to indicate the synchronization status |
| 63 status (string one of "bookmarks", "history", "passwords", | |
| 64 "useragents" or "speeddial", string) | |
| 65 </dd> | 60 </dd> |
| 66 </dl> | 61 </dl> |
| 67 <h3>Derived from</h3> | 62 <h3>Derived from</h3> |
| 68 SyncHandler | 63 SyncHandler |
| 69 <h3>Class Attributes</h3> | 64 <h3>Class Attributes</h3> |
| 170 <p> | 165 <p> |
| 171 Constructor | 166 Constructor |
| 172 </p> | 167 </p> |
| 173 <dl> | 168 <dl> |
| 174 | 169 |
| 175 <dt><i>parent</i></dt> | 170 <dt><i>parent</i> (QObject)</dt> |
| 176 <dd> | 171 <dd> |
| 177 reference to the parent object (QObject) | 172 reference to the parent object |
| 178 </dd> | 173 </dd> |
| 179 </dl> | 174 </dl> |
| 180 <a NAME="FtpSyncHandler.__changeToStore" ID="FtpSyncHandler.__changeToStore"></a> | 175 <a NAME="FtpSyncHandler.__changeToStore" ID="FtpSyncHandler.__changeToStore"></a> |
| 181 <h4>FtpSyncHandler.__changeToStore</h4> | 176 <h4>FtpSyncHandler.__changeToStore</h4> |
| 182 <b>__changeToStore</b>(<i></i>) | 177 <b>__changeToStore</b>(<i></i>) |
| 197 Private method to connect to the FTP server and log in. | 192 Private method to connect to the FTP server and log in. |
| 198 </p> | 193 </p> |
| 199 <dl> | 194 <dl> |
| 200 <dt>Return:</dt> | 195 <dt>Return:</dt> |
| 201 <dd> | 196 <dd> |
| 202 flag indicating a successful log in (boolean) | 197 flag indicating a successful log in |
| 198 </dd> | |
| 199 </dl> | |
| 200 <dl> | |
| 201 <dt>Return Type:</dt> | |
| 202 <dd> | |
| 203 bool | |
| 203 </dd> | 204 </dd> |
| 204 </dl> | 205 </dl> |
| 205 <a NAME="FtpSyncHandler.__dirListCallback" ID="FtpSyncHandler.__dirListCallback"></a> | 206 <a NAME="FtpSyncHandler.__dirListCallback" ID="FtpSyncHandler.__dirListCallback"></a> |
| 206 <h4>FtpSyncHandler.__dirListCallback</h4> | 207 <h4>FtpSyncHandler.__dirListCallback</h4> |
| 207 <b>__dirListCallback</b>(<i>line</i>) | 208 <b>__dirListCallback</b>(<i>line</i>) |
| 209 <p> | 210 <p> |
| 210 Private slot handling the receipt of directory listing lines. | 211 Private slot handling the receipt of directory listing lines. |
| 211 </p> | 212 </p> |
| 212 <dl> | 213 <dl> |
| 213 | 214 |
| 214 <dt><i>line</i></dt> | 215 <dt><i>line</i> (str)</dt> |
| 215 <dd> | 216 <dd> |
| 216 the received line of the directory listing (string) | 217 the received line of the directory listing |
| 217 </dd> | 218 </dd> |
| 218 </dl> | 219 </dl> |
| 219 <a NAME="FtpSyncHandler.__doFtpCommands" ID="FtpSyncHandler.__doFtpCommands"></a> | 220 <a NAME="FtpSyncHandler.__doFtpCommands" ID="FtpSyncHandler.__doFtpCommands"></a> |
| 220 <h4>FtpSyncHandler.__doFtpCommands</h4> | 221 <h4>FtpSyncHandler.__doFtpCommands</h4> |
| 221 <b>__doFtpCommands</b>(<i></i>) | 222 <b>__doFtpCommands</b>(<i></i>) |
| 230 <p> | 231 <p> |
| 231 Private method to downlaod the given file. | 232 Private method to downlaod the given file. |
| 232 </p> | 233 </p> |
| 233 <dl> | 234 <dl> |
| 234 | 235 |
| 235 <dt><i>type_</i></dt> | 236 <dt><i>type_</i> (str)</dt> |
| 236 <dd> | 237 <dd> |
| 237 type of the synchronization event (string one | 238 type of the synchronization event (one of |
| 238 of "bookmarks", "history", "passwords", "useragents" or | 239 "bookmarks", "history", "passwords", "useragents" or "speeddial") |
| 239 "speeddial") | 240 </dd> |
| 240 </dd> | 241 <dt><i>fileName</i> (str)</dt> |
| 241 <dt><i>fileName</i></dt> | 242 <dd> |
| 242 <dd> | 243 name of the file to be downloaded |
| 243 name of the file to be downloaded (string) | 244 </dd> |
| 244 </dd> | 245 <dt><i>timestamp</i> (int)</dt> |
| 245 <dt><i>timestamp</i></dt> | |
| 246 <dd> | 246 <dd> |
| 247 time stamp in seconds of the file to be downloaded | 247 time stamp in seconds of the file to be downloaded |
| 248 (integer) | |
| 249 </dd> | 248 </dd> |
| 250 </dl> | 249 </dl> |
| 251 <a NAME="FtpSyncHandler.__downloadFileCallback" ID="FtpSyncHandler.__downloadFileCallback"></a> | 250 <a NAME="FtpSyncHandler.__downloadFileCallback" ID="FtpSyncHandler.__downloadFileCallback"></a> |
| 252 <h4>FtpSyncHandler.__downloadFileCallback</h4> | 251 <h4>FtpSyncHandler.__downloadFileCallback</h4> |
| 253 <b>__downloadFileCallback</b>(<i>buffer, data</i>) | 252 <b>__downloadFileCallback</b>(<i>buffer, data</i>) |
| 255 <p> | 254 <p> |
| 256 Private method receiving the downloaded data. | 255 Private method receiving the downloaded data. |
| 257 </p> | 256 </p> |
| 258 <dl> | 257 <dl> |
| 259 | 258 |
| 260 <dt><i>buffer</i></dt> | 259 <dt><i>buffer</i> (io.BytesIO)</dt> |
| 261 <dd> | 260 <dd> |
| 262 reference to the buffer (io.BytesIO) | 261 reference to the buffer |
| 263 </dd> | 262 </dd> |
| 264 <dt><i>data</i></dt> | 263 <dt><i>data</i> (bytes)</dt> |
| 265 <dd> | 264 <dd> |
| 266 byte string to store in the buffer (bytes) | 265 byte string to store in the buffer |
| 267 </dd> | 266 </dd> |
| 268 </dl> | 267 </dl> |
| 269 <dl> | 268 <dl> |
| 270 <dt>Return:</dt> | 269 <dt>Return:</dt> |
| 271 <dd> | 270 <dd> |
| 272 number of bytes written to the buffer (integer) | 271 number of bytes written to the buffer |
| 272 </dd> | |
| 273 </dl> | |
| 274 <dl> | |
| 275 <dt>Return Type:</dt> | |
| 276 <dd> | |
| 277 int | |
| 273 </dd> | 278 </dd> |
| 274 </dl> | 279 </dl> |
| 275 <a NAME="FtpSyncHandler.__idleTimeout" ID="FtpSyncHandler.__idleTimeout"></a> | 280 <a NAME="FtpSyncHandler.__idleTimeout" ID="FtpSyncHandler.__idleTimeout"></a> |
| 276 <h4>FtpSyncHandler.__idleTimeout</h4> | 281 <h4>FtpSyncHandler.__idleTimeout</h4> |
| 277 <b>__idleTimeout</b>(<i></i>) | 282 <b>__idleTimeout</b>(<i></i>) |
| 293 <p> | 298 <p> |
| 294 Private method to do the initial synchronization of the given file. | 299 Private method to do the initial synchronization of the given file. |
| 295 </p> | 300 </p> |
| 296 <dl> | 301 <dl> |
| 297 | 302 |
| 298 <dt><i>type_</i></dt> | 303 <dt><i>type_</i> (str)</dt> |
| 299 <dd> | 304 <dd> |
| 300 type of the synchronization event (string one | 305 type of the synchronization event (one of "bookmarks", |
| 301 of "bookmarks", "history", "passwords", "useragents" or | 306 "history", "passwords", "useragents" or "speeddial") |
| 302 "speeddial") | 307 </dd> |
| 303 </dd> | 308 <dt><i>fileName</i> (str)</dt> |
| 304 <dt><i>fileName</i></dt> | 309 <dd> |
| 305 <dd> | 310 name of the file to be synchronized |
| 306 name of the file to be synchronized (string) | |
| 307 </dd> | 311 </dd> |
| 308 </dl> | 312 </dl> |
| 309 <a NAME="FtpSyncHandler.__syncFile" ID="FtpSyncHandler.__syncFile"></a> | 313 <a NAME="FtpSyncHandler.__syncFile" ID="FtpSyncHandler.__syncFile"></a> |
| 310 <h4>FtpSyncHandler.__syncFile</h4> | 314 <h4>FtpSyncHandler.__syncFile</h4> |
| 311 <b>__syncFile</b>(<i>type_, fileName</i>) | 315 <b>__syncFile</b>(<i>type_, fileName</i>) |
| 313 <p> | 317 <p> |
| 314 Private method to synchronize the given file. | 318 Private method to synchronize the given file. |
| 315 </p> | 319 </p> |
| 316 <dl> | 320 <dl> |
| 317 | 321 |
| 318 <dt><i>type_</i></dt> | 322 <dt><i>type_</i> (str)</dt> |
| 319 <dd> | 323 <dd> |
| 320 type of the synchronization event (string one | 324 type of the synchronization event (one of "bookmarks", |
| 321 of "bookmarks", "history", "passwords", "useragents" or | 325 "history", "passwords", "useragents" or "speeddial") |
| 322 "speeddial") | 326 </dd> |
| 323 </dd> | 327 <dt><i>fileName</i> (str)</dt> |
| 324 <dt><i>fileName</i></dt> | 328 <dd> |
| 325 <dd> | 329 name of the file to be synchronized |
| 326 name of the file to be synchronized (string) | |
| 327 </dd> | 330 </dd> |
| 328 </dl> | 331 </dl> |
| 329 <a NAME="FtpSyncHandler.__uploadFile" ID="FtpSyncHandler.__uploadFile"></a> | 332 <a NAME="FtpSyncHandler.__uploadFile" ID="FtpSyncHandler.__uploadFile"></a> |
| 330 <h4>FtpSyncHandler.__uploadFile</h4> | 333 <h4>FtpSyncHandler.__uploadFile</h4> |
| 331 <b>__uploadFile</b>(<i>type_, fileName</i>) | 334 <b>__uploadFile</b>(<i>type_, fileName</i>) |
| 333 <p> | 336 <p> |
| 334 Private method to upload the given file. | 337 Private method to upload the given file. |
| 335 </p> | 338 </p> |
| 336 <dl> | 339 <dl> |
| 337 | 340 |
| 338 <dt><i>type_</i></dt> | 341 <dt><i>type_</i> (str)</dt> |
| 339 <dd> | 342 <dd> |
| 340 type of the synchronization event (string one | 343 type of the synchronization event (one of "bookmarks", |
| 341 of "bookmarks", "history", "passwords", "useragents" or | 344 "history", "passwords", "useragents" or "speeddial") |
| 342 "speeddial") | 345 </dd> |
| 343 </dd> | 346 <dt><i>fileName</i> (str)</dt> |
| 344 <dt><i>fileName</i></dt> | 347 <dd> |
| 345 <dd> | 348 name of the file to be uploaded |
| 346 name of the file to be uploaded (string) | |
| 347 </dd> | 349 </dd> |
| 348 </dl> | 350 </dl> |
| 349 <dl> | 351 <dl> |
| 350 <dt>Return:</dt> | 352 <dt>Return:</dt> |
| 351 <dd> | 353 <dd> |
| 352 flag indicating success (boolean) | 354 flag indicating success |
| 355 </dd> | |
| 356 </dl> | |
| 357 <dl> | |
| 358 <dt>Return Type:</dt> | |
| 359 <dd> | |
| 360 bool | |
| 353 </dd> | 361 </dd> |
| 354 </dl> | 362 </dl> |
| 355 <a NAME="FtpSyncHandler.initialLoadAndCheck" ID="FtpSyncHandler.initialLoadAndCheck"></a> | 363 <a NAME="FtpSyncHandler.initialLoadAndCheck" ID="FtpSyncHandler.initialLoadAndCheck"></a> |
| 356 <h4>FtpSyncHandler.initialLoadAndCheck</h4> | 364 <h4>FtpSyncHandler.initialLoadAndCheck</h4> |
| 357 <b>initialLoadAndCheck</b>(<i>forceUpload</i>) | 365 <b>initialLoadAndCheck</b>(<i>forceUpload</i>) |
| 359 <p> | 367 <p> |
| 360 Public method to do the initial check. | 368 Public method to do the initial check. |
| 361 </p> | 369 </p> |
| 362 <dl> | 370 <dl> |
| 363 | 371 |
| 364 <dt><i>forceUpload</i></dt> | 372 <dt><i>forceUpload</i> (bool)</dt> |
| 365 <dd> | 373 <dd> |
| 366 flag indicating a forced upload of the files | 374 flag indicating a forced upload of the files |
| 367 (boolean) | |
| 368 </dd> | 375 </dd> |
| 369 </dl> | 376 </dl> |
| 370 <a NAME="FtpSyncHandler.shutdown" ID="FtpSyncHandler.shutdown"></a> | 377 <a NAME="FtpSyncHandler.shutdown" ID="FtpSyncHandler.shutdown"></a> |
| 371 <h4>FtpSyncHandler.shutdown</h4> | 378 <h4>FtpSyncHandler.shutdown</h4> |
| 372 <b>shutdown</b>(<i></i>) | 379 <b>shutdown</b>(<i></i>) |
