Documentation/Source/eric5.Helpviewer.Sync.DirectorySyncHandler.html

changeset 3018
70924c0bdaf1
parent 2387
2d119e79ab54
equal deleted inserted replaced
3017:6a8cb7632448 3018:70924c0bdaf1
45 Class implementing a synchronization handler using a shared directory. 45 Class implementing a synchronization handler using a shared directory.
46 </p><h3>Signals</h3> 46 </p><h3>Signals</h3>
47 <dl> 47 <dl>
48 <dt>syncError(message)</dt> 48 <dt>syncError(message)</dt>
49 <dd> 49 <dd>
50 emitted for a general error with the error message (string) 50 emitted for a general error with the error
51 message (string)
51 </dd><dt>syncFinished(type_, done, download)</dt> 52 </dd><dt>syncFinished(type_, done, download)</dt>
52 <dd> 53 <dd>
53 emitted after a synchronization has 54 emitted after a
54 finished (string one of "bookmarks", "history", "passwords", "useragents" or 55 synchronization has finished (string one of "bookmarks", "history",
55 "speeddial", boolean, boolean) 56 "passwords", "useragents" or "speeddial", boolean, boolean)
56 </dd><dt>syncMessage(message)</dt> 57 </dd><dt>syncMessage(message)</dt>
57 <dd> 58 <dd>
58 emitted to send a message about synchronization (string) 59 emitted to send a message about
60 synchronization (string)
59 </dd><dt>syncStatus(type_, message)</dt> 61 </dd><dt>syncStatus(type_, message)</dt>
60 <dd> 62 <dd>
61 emitted to indicate the synchronization 63 emitted to indicate the synchronization
62 status (string one of "bookmarks", "history", "passwords", "useragents" or 64 status (string one of "bookmarks", "history", "passwords",
63 "speeddial", string) 65 "useragents" or "speeddial", string)
64 </dd> 66 </dd>
65 </dl> 67 </dl>
66 <h3>Derived from</h3> 68 <h3>Derived from</h3>
67 SyncHandler 69 SyncHandler
68 <h3>Class Attributes</h3> 70 <h3>Class Attributes</h3>
137 Private method to downlaod the given file. 139 Private method to downlaod the given file.
138 </p><dl> 140 </p><dl>
139 <dt><i>type_</i></dt> 141 <dt><i>type_</i></dt>
140 <dd> 142 <dd>
141 type of the synchronization event (string one 143 type of the synchronization event (string one
142 of "bookmarks", "history", "passwords", "useragents" or "speeddial") 144 of "bookmarks", "history", "passwords", "useragents" or
145 "speeddial")
143 </dd><dt><i>fileName</i></dt> 146 </dd><dt><i>fileName</i></dt>
144 <dd> 147 <dd>
145 name of the file to be downloaded (string) 148 name of the file to be downloaded (string)
146 </dd><dt><i>timestamp</i></dt> 149 </dd><dt><i>timestamp</i></dt>
147 <dd> 150 <dd>
148 time stamp in seconds of the file to be downloaded (int) 151 time stamp in seconds of the file to be downloaded
152 (integer)
149 </dd> 153 </dd>
150 </dl><a NAME="DirectorySyncHandler.__initialSync" ID="DirectorySyncHandler.__initialSync"></a> 154 </dl><a NAME="DirectorySyncHandler.__initialSync" ID="DirectorySyncHandler.__initialSync"></a>
151 <h4>DirectorySyncHandler.__initialSync</h4> 155 <h4>DirectorySyncHandler.__initialSync</h4>
152 <b>__initialSync</b>(<i></i>) 156 <b>__initialSync</b>(<i></i>)
153 <p> 157 <p>
159 Private method to do the initial synchronization of the given file. 163 Private method to do the initial synchronization of the given file.
160 </p><dl> 164 </p><dl>
161 <dt><i>type_</i></dt> 165 <dt><i>type_</i></dt>
162 <dd> 166 <dd>
163 type of the synchronization event (string one 167 type of the synchronization event (string one
164 of "bookmarks", "history", "passwords", "useragents" or "speeddial") 168 of "bookmarks", "history", "passwords", "useragents" or
169 "speeddial")
165 </dd><dt><i>fileName</i></dt> 170 </dd><dt><i>fileName</i></dt>
166 <dd> 171 <dd>
167 name of the file to be synchronized (string) 172 name of the file to be synchronized (string)
168 </dd> 173 </dd>
169 </dl><a NAME="DirectorySyncHandler.__syncFile" ID="DirectorySyncHandler.__syncFile"></a> 174 </dl><a NAME="DirectorySyncHandler.__syncFile" ID="DirectorySyncHandler.__syncFile"></a>
173 Private method to synchronize the given file. 178 Private method to synchronize the given file.
174 </p><dl> 179 </p><dl>
175 <dt><i>type_</i></dt> 180 <dt><i>type_</i></dt>
176 <dd> 181 <dd>
177 type of the synchronization event (string one 182 type of the synchronization event (string one
178 of "bookmarks", "history", "passwords", "useragents" or "speeddial") 183 of "bookmarks", "history", "passwords", "useragents" or
184 "speeddial")
179 </dd><dt><i>fileName</i></dt> 185 </dd><dt><i>fileName</i></dt>
180 <dd> 186 <dd>
181 name of the file to be synchronized (string) 187 name of the file to be synchronized (string)
182 </dd> 188 </dd>
183 </dl><a NAME="DirectorySyncHandler.__uploadFile" ID="DirectorySyncHandler.__uploadFile"></a> 189 </dl><a NAME="DirectorySyncHandler.__uploadFile" ID="DirectorySyncHandler.__uploadFile"></a>
187 Private method to upload the given file. 193 Private method to upload the given file.
188 </p><dl> 194 </p><dl>
189 <dt><i>type_</i></dt> 195 <dt><i>type_</i></dt>
190 <dd> 196 <dd>
191 type of the synchronization event (string one 197 type of the synchronization event (string one
192 of "bookmarks", "history", "passwords", "useragents" or "speeddial") 198 of "bookmarks", "history", "passwords", "useragents" or
199 "speeddial")
193 </dd><dt><i>fileName</i></dt> 200 </dd><dt><i>fileName</i></dt>
194 <dd> 201 <dd>
195 name of the file to be uploaded (string) 202 name of the file to be uploaded (string)
196 </dd> 203 </dd>
197 </dl><a NAME="DirectorySyncHandler.initialLoadAndCheck" ID="DirectorySyncHandler.initialLoadAndCheck"></a> 204 </dl><a NAME="DirectorySyncHandler.initialLoadAndCheck" ID="DirectorySyncHandler.initialLoadAndCheck"></a>
200 <p> 207 <p>
201 Public method to do the initial check. 208 Public method to do the initial check.
202 </p><dl> 209 </p><dl>
203 <dt><i>forceUpload=</i></dt> 210 <dt><i>forceUpload=</i></dt>
204 <dd> 211 <dd>
205 flag indicating a forced upload of the files (boolean) 212 flag indicating a forced upload of the files
213 (boolean)
206 </dd> 214 </dd>
207 </dl><a NAME="DirectorySyncHandler.shutdown" ID="DirectorySyncHandler.shutdown"></a> 215 </dl><a NAME="DirectorySyncHandler.shutdown" ID="DirectorySyncHandler.shutdown"></a>
208 <h4>DirectorySyncHandler.shutdown</h4> 216 <h4>DirectorySyncHandler.shutdown</h4>
209 <b>shutdown</b>(<i></i>) 217 <b>shutdown</b>(<i></i>)
210 <p> 218 <p>

eric ide

mercurial