eric6/Documentation/Source/eric6.Helpviewer.Sync.SyncHandler.html

branch
maintenance
changeset 7286
7eb04391adf7
parent 7226
babe80d84a3e
parent 7285
1ff497f33f31
child 7287
1c17f2191bdd
equal deleted inserted replaced
7226:babe80d84a3e 7286:7eb04391adf7
1 <!DOCTYPE html>
2 <html><head>
3 <title>eric6.Helpviewer.Sync.SyncHandler</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.Sync.SyncHandler</h1>
23 <p>
24 Module containing a base class for synchronization handlers.
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="#SyncHandler">SyncHandler</a></td>
34 <td>Base class for synchronization handlers.</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="SyncHandler" ID="SyncHandler"></a>
43 <h2>SyncHandler</h2>
44 <p>
45 Base class for synchronization handlers.
46 </p><h3>Signals</h3>
47 <dl>
48 <dt>syncError(message)</dt>
49 <dd>
50 emitted for a general error with the error
51 message (string)
52 </dd><dt>syncFinished(type_, done, download)</dt>
53 <dd>
54 emitted after a
55 synchronization has finished (string one of "bookmarks", "history",
56 "passwords", "useragents" or "speeddial", boolean, boolean)
57 </dd><dt>syncMessage(message)</dt>
58 <dd>
59 emitted to send a message about
60 synchronization (string)
61 </dd><dt>syncStatus(type_, message)</dt>
62 <dd>
63 emitted to indicate the synchronization
64 status (string one of "bookmarks", "history", "passwords",
65 "useragents" or "speeddial", string)
66 </dd>
67 </dl>
68 <h3>Derived from</h3>
69 QObject
70 <h3>Class Attributes</h3>
71 <table>
72 <tr><td>None</td></tr>
73 </table>
74 <h3>Class Methods</h3>
75 <table>
76 <tr><td>None</td></tr>
77 </table>
78 <h3>Methods</h3>
79 <table>
80 <tr>
81 <td><a href="#SyncHandler.__init__">SyncHandler</a></td>
82 <td>Constructor</td>
83 </tr><tr>
84 <td><a href="#SyncHandler.initialLoadAndCheck">initialLoadAndCheck</a></td>
85 <td>Public method to do the initial check.</td>
86 </tr><tr>
87 <td><a href="#SyncHandler.readFile">readFile</a></td>
88 <td>Public method to read a file.</td>
89 </tr><tr>
90 <td><a href="#SyncHandler.shutdown">shutdown</a></td>
91 <td>Public method to shut down the handler.</td>
92 </tr><tr>
93 <td><a href="#SyncHandler.syncBookmarks">syncBookmarks</a></td>
94 <td>Public method to synchronize the bookmarks.</td>
95 </tr><tr>
96 <td><a href="#SyncHandler.syncHistory">syncHistory</a></td>
97 <td>Public method to synchronize the history.</td>
98 </tr><tr>
99 <td><a href="#SyncHandler.syncPasswords">syncPasswords</a></td>
100 <td>Public method to synchronize the passwords.</td>
101 </tr><tr>
102 <td><a href="#SyncHandler.syncSpeedDial">syncSpeedDial</a></td>
103 <td>Public method to synchronize the speed dial data.</td>
104 </tr><tr>
105 <td><a href="#SyncHandler.syncUserAgents">syncUserAgents</a></td>
106 <td>Public method to synchronize the user agents.</td>
107 </tr><tr>
108 <td><a href="#SyncHandler.writeFile">writeFile</a></td>
109 <td>Public method to write the data to a file.</td>
110 </tr>
111 </table>
112 <h3>Static Methods</h3>
113 <table>
114 <tr><td>None</td></tr>
115 </table>
116 <a NAME="SyncHandler.__init__" ID="SyncHandler.__init__"></a>
117 <h4>SyncHandler (Constructor)</h4>
118 <b>SyncHandler</b>(<i>parent=None</i>)
119 <p>
120 Constructor
121 </p><dl>
122 <dt><i>parent</i></dt>
123 <dd>
124 reference to the parent object (QObject)
125 </dd>
126 </dl><a NAME="SyncHandler.initialLoadAndCheck" ID="SyncHandler.initialLoadAndCheck"></a>
127 <h4>SyncHandler.initialLoadAndCheck</h4>
128 <b>initialLoadAndCheck</b>(<i>forceUpload</i>)
129 <p>
130 Public method to do the initial check.
131 </p><dl>
132 <dt><i>forceUpload=</i></dt>
133 <dd>
134 flag indicating a forced upload of the files
135 (boolean)
136 </dd>
137 </dl><dl>
138 <dt>Raises <b>NotImplementedError</b>:</dt>
139 <dd>
140 raised to indicate that this method
141 must be implemented by subclasses
142 </dd>
143 </dl><a NAME="SyncHandler.readFile" ID="SyncHandler.readFile"></a>
144 <h4>SyncHandler.readFile</h4>
145 <b>readFile</b>(<i>fileName, type_</i>)
146 <p>
147 Public method to read a file.
148 </p><p>
149 If encrypted synchronization is enabled, the data will be encrypted
150 using the relevant encryption key.
151 </p><dl>
152 <dt><i>fileName</i></dt>
153 <dd>
154 name of the file to be read (string)
155 </dd><dt><i>type_</i></dt>
156 <dd>
157 type of the synchronization event (string one
158 of "bookmarks", "history", "passwords", "useragents" or
159 "speeddial")
160 </dd>
161 </dl><dl>
162 <dt>Returns:</dt>
163 <dd>
164 data of the file, optionally encrypted (QByteArray)
165 </dd>
166 </dl><a NAME="SyncHandler.shutdown" ID="SyncHandler.shutdown"></a>
167 <h4>SyncHandler.shutdown</h4>
168 <b>shutdown</b>(<i></i>)
169 <p>
170 Public method to shut down the handler.
171 </p><dl>
172 <dt>Raises <b>NotImplementedError</b>:</dt>
173 <dd>
174 raised to indicate that this method
175 must be implemented by subclasses
176 </dd>
177 </dl><a NAME="SyncHandler.syncBookmarks" ID="SyncHandler.syncBookmarks"></a>
178 <h4>SyncHandler.syncBookmarks</h4>
179 <b>syncBookmarks</b>(<i></i>)
180 <p>
181 Public method to synchronize the bookmarks.
182 </p><dl>
183 <dt>Raises <b>NotImplementedError</b>:</dt>
184 <dd>
185 raised to indicate that this method
186 must be implemented by subclasses
187 </dd>
188 </dl><a NAME="SyncHandler.syncHistory" ID="SyncHandler.syncHistory"></a>
189 <h4>SyncHandler.syncHistory</h4>
190 <b>syncHistory</b>(<i></i>)
191 <p>
192 Public method to synchronize the history.
193 </p><dl>
194 <dt>Raises <b>NotImplementedError</b>:</dt>
195 <dd>
196 raised to indicate that this method
197 must be implemented by subclasses
198 </dd>
199 </dl><a NAME="SyncHandler.syncPasswords" ID="SyncHandler.syncPasswords"></a>
200 <h4>SyncHandler.syncPasswords</h4>
201 <b>syncPasswords</b>(<i></i>)
202 <p>
203 Public method to synchronize the passwords.
204 </p><dl>
205 <dt>Raises <b>NotImplementedError</b>:</dt>
206 <dd>
207 raised to indicate that this method
208 must be implemented by subclasses
209 </dd>
210 </dl><a NAME="SyncHandler.syncSpeedDial" ID="SyncHandler.syncSpeedDial"></a>
211 <h4>SyncHandler.syncSpeedDial</h4>
212 <b>syncSpeedDial</b>(<i></i>)
213 <p>
214 Public method to synchronize the speed dial data.
215 </p><dl>
216 <dt>Raises <b>NotImplementedError</b>:</dt>
217 <dd>
218 raised to indicate that this method
219 must be implemented by subclasses
220 </dd>
221 </dl><a NAME="SyncHandler.syncUserAgents" ID="SyncHandler.syncUserAgents"></a>
222 <h4>SyncHandler.syncUserAgents</h4>
223 <b>syncUserAgents</b>(<i></i>)
224 <p>
225 Public method to synchronize the user agents.
226 </p><dl>
227 <dt>Raises <b>NotImplementedError</b>:</dt>
228 <dd>
229 raised to indicate that this method
230 must be implemented by subclasses
231 </dd>
232 </dl><a NAME="SyncHandler.writeFile" ID="SyncHandler.writeFile"></a>
233 <h4>SyncHandler.writeFile</h4>
234 <b>writeFile</b>(<i>data, fileName, type_, timestamp=0</i>)
235 <p>
236 Public method to write the data to a file.
237 </p><p>
238 If encrypted synchronization is enabled, the data will be decrypted
239 using the relevant encryption key.
240 </p><dl>
241 <dt><i>data</i></dt>
242 <dd>
243 data to be written and optionally decrypted (QByteArray)
244 </dd><dt><i>fileName</i></dt>
245 <dd>
246 name of the file the data is to be written to (string)
247 </dd><dt><i>type_</i></dt>
248 <dd>
249 type of the synchronization event (string one
250 of "bookmarks", "history", "passwords", "useragents" or
251 "speeddial")
252 </dd><dt><i>timestamp</i></dt>
253 <dd>
254 timestamp to be given to the file (int)
255 </dd>
256 </dl><dl>
257 <dt>Returns:</dt>
258 <dd>
259 tuple giving a success flag and an error string (boolean,
260 string)
261 </dd>
262 </dl>
263 <div align="right"><a href="#top">Up</a></div>
264 <hr />
265 </body></html>

eric ide

mercurial