src/eric7/Documentation/Source/eric7.WebBrowser.Sync.DirectorySyncHandler.html

branch
eric7
changeset 10479
856476537696
parent 10436
f6881d10e995
equal deleted inserted replaced
10478:de9106c55c3d 10479:856476537696
5 <link rel="stylesheet" href="styles.css"> 5 <link rel="stylesheet" href="styles.css">
6 </head> 6 </head>
7 <body> 7 <body>
8 <a NAME="top" ID="top"></a> 8 <a NAME="top" ID="top"></a>
9 <h1>eric7.WebBrowser.Sync.DirectorySyncHandler</h1> 9 <h1>eric7.WebBrowser.Sync.DirectorySyncHandler</h1>
10
11 <p> 10 <p>
12 Module implementing a synchronization handler using a shared directory. 11 Module implementing a synchronization handler using a shared directory.
13 </p> 12 </p>
13
14 <h3>Global Attributes</h3> 14 <h3>Global Attributes</h3>
15 15 <table>
16 <table> 16 <tr><td>None</td></tr>
17 <tr><td>None</td></tr> 17 </table>
18 </table> 18
19 <h3>Classes</h3> 19 <h3>Classes</h3>
20 20 <table>
21 <table>
22
23 <tr> 21 <tr>
24 <td><a href="#DirectorySyncHandler">DirectorySyncHandler</a></td> 22 <td><a href="#DirectorySyncHandler">DirectorySyncHandler</a></td>
25 <td>Class implementing a synchronization handler using a shared directory.</td> 23 <td>Class implementing a synchronization handler using a shared directory.</td>
26 </tr> 24 </tr>
27 </table> 25 </table>
26
28 <h3>Functions</h3> 27 <h3>Functions</h3>
29 28 <table>
30 <table> 29 <tr><td>None</td></tr>
31 <tr><td>None</td></tr> 30 </table>
32 </table> 31
33 <hr /> 32 <hr />
34 <hr /> 33 <hr />
35 <a NAME="DirectorySyncHandler" ID="DirectorySyncHandler"></a> 34 <a NAME="DirectorySyncHandler" ID="DirectorySyncHandler"></a>
36 <h2>DirectorySyncHandler</h2> 35 <h2>DirectorySyncHandler</h2>
37
38 <p> 36 <p>
39 Class implementing a synchronization handler using a shared directory. 37 Class implementing a synchronization handler using a shared directory.
40 </p> 38 </p>
39
41 <h3>Signals</h3> 40 <h3>Signals</h3>
42 <dl> 41 <dl>
43 42
44 <dt>syncError(message)</dt> 43 <dt>syncError(message)</dt>
45 <dd> 44 <dd>
60 </dd> 59 </dd>
61 </dl> 60 </dl>
62 <h3>Derived from</h3> 61 <h3>Derived from</h3>
63 SyncHandler 62 SyncHandler
64 <h3>Class Attributes</h3> 63 <h3>Class Attributes</h3>
65 64 <table>
66 <table> 65 <tr><td>None</td></tr>
67 <tr><td>None</td></tr> 66 </table>
68 </table> 67
69 <h3>Class Methods</h3> 68 <h3>Class Methods</h3>
70 69 <table>
71 <table> 70 <tr><td>None</td></tr>
72 <tr><td>None</td></tr> 71 </table>
73 </table> 72
74 <h3>Methods</h3> 73 <h3>Methods</h3>
75 74 <table>
76 <table>
77
78 <tr> 75 <tr>
79 <td><a href="#DirectorySyncHandler.__init__">DirectorySyncHandler</a></td> 76 <td><a href="#DirectorySyncHandler.__init__">DirectorySyncHandler</a></td>
80 <td>Constructor</td> 77 <td>Constructor</td>
81 </tr> 78 </tr>
82 <tr> 79 <tr>
126 <tr> 123 <tr>
127 <td><a href="#DirectorySyncHandler.syncUserAgents">syncUserAgents</a></td> 124 <td><a href="#DirectorySyncHandler.syncUserAgents">syncUserAgents</a></td>
128 <td>Public method to synchronize the user agents.</td> 125 <td>Public method to synchronize the user agents.</td>
129 </tr> 126 </tr>
130 </table> 127 </table>
128
131 <h3>Static Methods</h3> 129 <h3>Static Methods</h3>
132 130 <table>
133 <table> 131 <tr><td>None</td></tr>
134 <tr><td>None</td></tr> 132 </table>
135 </table> 133
136 134
137 <a NAME="DirectorySyncHandler.__init__" ID="DirectorySyncHandler.__init__"></a> 135 <a NAME="DirectorySyncHandler.__init__" ID="DirectorySyncHandler.__init__"></a>
138 <h4>DirectorySyncHandler (Constructor)</h4> 136 <h4>DirectorySyncHandler (Constructor)</h4>
139 <b>DirectorySyncHandler</b>(<i>parent=None</i>) 137 <b>DirectorySyncHandler</b>(<i>parent=None</i>)
140
141 <p> 138 <p>
142 Constructor 139 Constructor
143 </p> 140 </p>
141
144 <dl> 142 <dl>
145 143
146 <dt><i>parent</i> (QObject)</dt> 144 <dt><i>parent</i> (QObject)</dt>
147 <dd> 145 <dd>
148 reference to the parent object 146 reference to the parent object
149 </dd> 147 </dd>
150 </dl> 148 </dl>
151 <a NAME="DirectorySyncHandler.__downloadFile" ID="DirectorySyncHandler.__downloadFile"></a> 149 <a NAME="DirectorySyncHandler.__downloadFile" ID="DirectorySyncHandler.__downloadFile"></a>
152 <h4>DirectorySyncHandler.__downloadFile</h4> 150 <h4>DirectorySyncHandler.__downloadFile</h4>
153 <b>__downloadFile</b>(<i>type_, fileName, timestamp</i>) 151 <b>__downloadFile</b>(<i>type_, fileName, timestamp</i>)
154
155 <p> 152 <p>
156 Private method to downlaod the given file. 153 Private method to downlaod the given file.
157 </p> 154 </p>
155
158 <dl> 156 <dl>
159 157
160 <dt><i>type_</i> (str)</dt> 158 <dt><i>type_</i> (str)</dt>
161 <dd> 159 <dd>
162 type of the synchronization event (one of 160 type of the synchronization event (one of
172 </dd> 170 </dd>
173 </dl> 171 </dl>
174 <a NAME="DirectorySyncHandler.__initialSync" ID="DirectorySyncHandler.__initialSync"></a> 172 <a NAME="DirectorySyncHandler.__initialSync" ID="DirectorySyncHandler.__initialSync"></a>
175 <h4>DirectorySyncHandler.__initialSync</h4> 173 <h4>DirectorySyncHandler.__initialSync</h4>
176 <b>__initialSync</b>(<i></i>) 174 <b>__initialSync</b>(<i></i>)
177
178 <p> 175 <p>
179 Private slot to do the initial synchronization. 176 Private slot to do the initial synchronization.
180 </p> 177 </p>
178
181 <a NAME="DirectorySyncHandler.__initialSyncFile" ID="DirectorySyncHandler.__initialSyncFile"></a> 179 <a NAME="DirectorySyncHandler.__initialSyncFile" ID="DirectorySyncHandler.__initialSyncFile"></a>
182 <h4>DirectorySyncHandler.__initialSyncFile</h4> 180 <h4>DirectorySyncHandler.__initialSyncFile</h4>
183 <b>__initialSyncFile</b>(<i>type_, fileName</i>) 181 <b>__initialSyncFile</b>(<i>type_, fileName</i>)
184
185 <p> 182 <p>
186 Private method to do the initial synchronization of the given file. 183 Private method to do the initial synchronization of the given file.
187 </p> 184 </p>
185
188 <dl> 186 <dl>
189 187
190 <dt><i>type_</i> (str)</dt> 188 <dt><i>type_</i> (str)</dt>
191 <dd> 189 <dd>
192 type of the synchronization event (one of "bookmarks", 190 type of the synchronization event (one of "bookmarks",
198 </dd> 196 </dd>
199 </dl> 197 </dl>
200 <a NAME="DirectorySyncHandler.__syncFile" ID="DirectorySyncHandler.__syncFile"></a> 198 <a NAME="DirectorySyncHandler.__syncFile" ID="DirectorySyncHandler.__syncFile"></a>
201 <h4>DirectorySyncHandler.__syncFile</h4> 199 <h4>DirectorySyncHandler.__syncFile</h4>
202 <b>__syncFile</b>(<i>type_, fileName</i>) 200 <b>__syncFile</b>(<i>type_, fileName</i>)
203
204 <p> 201 <p>
205 Private method to synchronize the given file. 202 Private method to synchronize the given file.
206 </p> 203 </p>
204
207 <dl> 205 <dl>
208 206
209 <dt><i>type_</i> (str)</dt> 207 <dt><i>type_</i> (str)</dt>
210 <dd> 208 <dd>
211 type of the synchronization event (one of "bookmarks", 209 type of the synchronization event (one of "bookmarks",
217 </dd> 215 </dd>
218 </dl> 216 </dl>
219 <a NAME="DirectorySyncHandler.__uploadFile" ID="DirectorySyncHandler.__uploadFile"></a> 217 <a NAME="DirectorySyncHandler.__uploadFile" ID="DirectorySyncHandler.__uploadFile"></a>
220 <h4>DirectorySyncHandler.__uploadFile</h4> 218 <h4>DirectorySyncHandler.__uploadFile</h4>
221 <b>__uploadFile</b>(<i>type_, fileName</i>) 219 <b>__uploadFile</b>(<i>type_, fileName</i>)
222
223 <p> 220 <p>
224 Private method to upload the given file. 221 Private method to upload the given file.
225 </p> 222 </p>
223
226 <dl> 224 <dl>
227 225
228 <dt><i>type_</i> (str)</dt> 226 <dt><i>type_</i> (str)</dt>
229 <dd> 227 <dd>
230 type of the synchronization event (one of "bookmarks", 228 type of the synchronization event (one of "bookmarks",
236 </dd> 234 </dd>
237 </dl> 235 </dl>
238 <a NAME="DirectorySyncHandler.initialLoadAndCheck" ID="DirectorySyncHandler.initialLoadAndCheck"></a> 236 <a NAME="DirectorySyncHandler.initialLoadAndCheck" ID="DirectorySyncHandler.initialLoadAndCheck"></a>
239 <h4>DirectorySyncHandler.initialLoadAndCheck</h4> 237 <h4>DirectorySyncHandler.initialLoadAndCheck</h4>
240 <b>initialLoadAndCheck</b>(<i>forceUpload</i>) 238 <b>initialLoadAndCheck</b>(<i>forceUpload</i>)
241
242 <p> 239 <p>
243 Public method to do the initial check. 240 Public method to do the initial check.
244 </p> 241 </p>
242
245 <dl> 243 <dl>
246 244
247 <dt><i>forceUpload</i> (bool)</dt> 245 <dt><i>forceUpload</i> (bool)</dt>
248 <dd> 246 <dd>
249 flag indicating a forced upload of the files 247 flag indicating a forced upload of the files
250 </dd> 248 </dd>
251 </dl> 249 </dl>
252 <a NAME="DirectorySyncHandler.shutdown" ID="DirectorySyncHandler.shutdown"></a> 250 <a NAME="DirectorySyncHandler.shutdown" ID="DirectorySyncHandler.shutdown"></a>
253 <h4>DirectorySyncHandler.shutdown</h4> 251 <h4>DirectorySyncHandler.shutdown</h4>
254 <b>shutdown</b>(<i></i>) 252 <b>shutdown</b>(<i></i>)
255
256 <p> 253 <p>
257 Public method to shut down the handler. 254 Public method to shut down the handler.
258 </p> 255 </p>
256
259 <a NAME="DirectorySyncHandler.syncBookmarks" ID="DirectorySyncHandler.syncBookmarks"></a> 257 <a NAME="DirectorySyncHandler.syncBookmarks" ID="DirectorySyncHandler.syncBookmarks"></a>
260 <h4>DirectorySyncHandler.syncBookmarks</h4> 258 <h4>DirectorySyncHandler.syncBookmarks</h4>
261 <b>syncBookmarks</b>(<i></i>) 259 <b>syncBookmarks</b>(<i></i>)
262
263 <p> 260 <p>
264 Public method to synchronize the bookmarks. 261 Public method to synchronize the bookmarks.
265 </p> 262 </p>
263
266 <a NAME="DirectorySyncHandler.syncHistory" ID="DirectorySyncHandler.syncHistory"></a> 264 <a NAME="DirectorySyncHandler.syncHistory" ID="DirectorySyncHandler.syncHistory"></a>
267 <h4>DirectorySyncHandler.syncHistory</h4> 265 <h4>DirectorySyncHandler.syncHistory</h4>
268 <b>syncHistory</b>(<i></i>) 266 <b>syncHistory</b>(<i></i>)
269
270 <p> 267 <p>
271 Public method to synchronize the history. 268 Public method to synchronize the history.
272 </p> 269 </p>
270
273 <a NAME="DirectorySyncHandler.syncPasswords" ID="DirectorySyncHandler.syncPasswords"></a> 271 <a NAME="DirectorySyncHandler.syncPasswords" ID="DirectorySyncHandler.syncPasswords"></a>
274 <h4>DirectorySyncHandler.syncPasswords</h4> 272 <h4>DirectorySyncHandler.syncPasswords</h4>
275 <b>syncPasswords</b>(<i></i>) 273 <b>syncPasswords</b>(<i></i>)
276
277 <p> 274 <p>
278 Public method to synchronize the passwords. 275 Public method to synchronize the passwords.
279 </p> 276 </p>
277
280 <a NAME="DirectorySyncHandler.syncSpeedDial" ID="DirectorySyncHandler.syncSpeedDial"></a> 278 <a NAME="DirectorySyncHandler.syncSpeedDial" ID="DirectorySyncHandler.syncSpeedDial"></a>
281 <h4>DirectorySyncHandler.syncSpeedDial</h4> 279 <h4>DirectorySyncHandler.syncSpeedDial</h4>
282 <b>syncSpeedDial</b>(<i></i>) 280 <b>syncSpeedDial</b>(<i></i>)
283
284 <p> 281 <p>
285 Public method to synchronize the speed dial data. 282 Public method to synchronize the speed dial data.
286 </p> 283 </p>
284
287 <a NAME="DirectorySyncHandler.syncUserAgents" ID="DirectorySyncHandler.syncUserAgents"></a> 285 <a NAME="DirectorySyncHandler.syncUserAgents" ID="DirectorySyncHandler.syncUserAgents"></a>
288 <h4>DirectorySyncHandler.syncUserAgents</h4> 286 <h4>DirectorySyncHandler.syncUserAgents</h4>
289 <b>syncUserAgents</b>(<i></i>) 287 <b>syncUserAgents</b>(<i></i>)
290
291 <p> 288 <p>
292 Public method to synchronize the user agents. 289 Public method to synchronize the user agents.
293 </p> 290 </p>
291
294 <div align="right"><a href="#top">Up</a></div> 292 <div align="right"><a href="#top">Up</a></div>
295 <hr /> 293 <hr />
296 </body></html> 294 </body></html>

eric ide

mercurial