src/eric7/Documentation/Source/eric7.WebBrowser.Sync.SyncHandler.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 QObject 63 QObject
69 <h3>Class Attributes</h3> 64 <h3>Class Attributes</h3>
134 <p> 129 <p>
135 Constructor 130 Constructor
136 </p> 131 </p>
137 <dl> 132 <dl>
138 133
139 <dt><i>parent</i></dt> 134 <dt><i>parent</i> (QObject)</dt>
140 <dd> 135 <dd>
141 reference to the parent object (QObject) 136 reference to the parent object
142 </dd> 137 </dd>
143 </dl> 138 </dl>
144 <a NAME="SyncHandler.initialLoadAndCheck" ID="SyncHandler.initialLoadAndCheck"></a> 139 <a NAME="SyncHandler.initialLoadAndCheck" ID="SyncHandler.initialLoadAndCheck"></a>
145 <h4>SyncHandler.initialLoadAndCheck</h4> 140 <h4>SyncHandler.initialLoadAndCheck</h4>
146 <b>initialLoadAndCheck</b>(<i>forceUpload</i>) 141 <b>initialLoadAndCheck</b>(<i>forceUpload</i>)
148 <p> 143 <p>
149 Public method to do the initial check. 144 Public method to do the initial check.
150 </p> 145 </p>
151 <dl> 146 <dl>
152 147
153 <dt><i>forceUpload</i></dt> 148 <dt><i>forceUpload</i> (bool)</dt>
154 <dd> 149 <dd>
155 flag indicating a forced upload of the files 150 flag indicating a forced upload of the files
156 (boolean)
157 </dd> 151 </dd>
158 </dl> 152 </dl>
159 <dl> 153 <dl>
160 154
161 <dt>Raises <b>NotImplementedError</b>:</dt> 155 <dt>Raises <b>NotImplementedError</b>:</dt>
175 If encrypted synchronization is enabled, the data will be encrypted 169 If encrypted synchronization is enabled, the data will be encrypted
176 using the relevant encryption key. 170 using the relevant encryption key.
177 </p> 171 </p>
178 <dl> 172 <dl>
179 173
180 <dt><i>fileName</i></dt> 174 <dt><i>fileName</i> (str)</dt>
181 <dd> 175 <dd>
182 name of the file to be read (string) 176 name of the file to be read
183 </dd> 177 </dd>
184 <dt><i>type_</i></dt> 178 <dt><i>type_</i> (str)</dt>
185 <dd> 179 <dd>
186 type of the synchronization event (string one 180 type of the synchronization event (one of "bookmarks",
187 of "bookmarks", "history", "passwords", "useragents" or 181 "history", "passwords", "useragents" or "speeddial")
188 "speeddial")
189 </dd> 182 </dd>
190 </dl> 183 </dl>
191 <dl> 184 <dl>
192 <dt>Return:</dt> 185 <dt>Return:</dt>
193 <dd> 186 <dd>
194 data of the file, optionally encrypted (QByteArray) 187 data of the file, optionally encrypted
188 </dd>
189 </dl>
190 <dl>
191 <dt>Return Type:</dt>
192 <dd>
193 QByteArray
195 </dd> 194 </dd>
196 </dl> 195 </dl>
197 <a NAME="SyncHandler.shutdown" ID="SyncHandler.shutdown"></a> 196 <a NAME="SyncHandler.shutdown" ID="SyncHandler.shutdown"></a>
198 <h4>SyncHandler.shutdown</h4> 197 <h4>SyncHandler.shutdown</h4>
199 <b>shutdown</b>(<i></i>) 198 <b>shutdown</b>(<i></i>)
295 If encrypted synchronization is enabled, the data will be decrypted 294 If encrypted synchronization is enabled, the data will be decrypted
296 using the relevant encryption key. 295 using the relevant encryption key.
297 </p> 296 </p>
298 <dl> 297 <dl>
299 298
300 <dt><i>data</i></dt> 299 <dt><i>data</i> (QByteArray)</dt>
301 <dd> 300 <dd>
302 data to be written and optionally decrypted (QByteArray) 301 data to be written and optionally decrypted
303 </dd> 302 </dd>
304 <dt><i>fileName</i></dt> 303 <dt><i>fileName</i> (str)</dt>
305 <dd> 304 <dd>
306 name of the file the data is to be written to (string) 305 name of the file the data is to be written to
307 </dd> 306 </dd>
308 <dt><i>type_</i></dt> 307 <dt><i>type_</i> (str)</dt>
309 <dd> 308 <dd>
310 type of the synchronization event (string one 309 type of the synchronization event (one of "bookmarks",
311 of "bookmarks", "history", "passwords", "useragents" or 310 "history", "passwords", "useragents" or "speeddial")
312 "speeddial") 311 </dd>
313 </dd> 312 <dt><i>timestamp</i> (int)</dt>
314 <dt><i>timestamp</i></dt> 313 <dd>
315 <dd> 314 timestamp to be given to the file
316 timestamp to be given to the file (int)
317 </dd> 315 </dd>
318 </dl> 316 </dl>
319 <dl> 317 <dl>
320 <dt>Return:</dt> 318 <dt>Return:</dt>
321 <dd> 319 <dd>
322 tuple giving a success flag and an error string (boolean, 320 tuple giving a success flag and an error string
323 string) 321 </dd>
322 </dl>
323 <dl>
324 <dt>Return Type:</dt>
325 <dd>
326 tuple of (bool, str)
324 </dd> 327 </dd>
325 </dl> 328 </dl>
326 <div align="right"><a href="#top">Up</a></div> 329 <div align="right"><a href="#top">Up</a></div>
327 <hr /> 330 <hr />
328 </body></html> 331 </body></html>

eric ide

mercurial