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

changeset 1680
28e57079dab5
parent 1626
a77c8ea8582c
child 1695
7b115f986d48
equal deleted inserted replaced
1679:422cc500eef9 1680:28e57079dab5
52 </dd><dt>syncFinished(type_, done, download)</dt> 52 </dd><dt>syncFinished(type_, done, download)</dt>
53 <dd> 53 <dd>
54 emitted after a synchronization has 54 emitted after a synchronization has
55 finished (string one of "bookmarks", "history", "passwords" or "useragents", 55 finished (string one of "bookmarks", "history", "passwords" or "useragents",
56 boolean, boolean) 56 boolean, boolean)
57 </dd><dt>syncMessage(message)</dt>
58 <dd>
59 emitted to send a message about synchronization (string)
57 </dd><dt>syncStatus(type_, done, message)</dt> 60 </dd><dt>syncStatus(type_, done, message)</dt>
58 <dd> 61 <dd>
59 emitted to indicate the synchronization 62 emitted to indicate the synchronization
60 status (string one of "bookmarks", "history", "passwords" or "useragents", 63 status (string one of "bookmarks", "history", "passwords" or "useragents",
61 boolean, string) 64 boolean, string)
78 <td>Constructor</td> 81 <td>Constructor</td>
79 </tr><tr> 82 </tr><tr>
80 <td><a href="#SyncHandler.initialLoadAndCheck">initialLoadAndCheck</a></td> 83 <td><a href="#SyncHandler.initialLoadAndCheck">initialLoadAndCheck</a></td>
81 <td>Public method to do the initial check.</td> 84 <td>Public method to do the initial check.</td>
82 </tr><tr> 85 </tr><tr>
86 <td><a href="#SyncHandler.readFile">readFile</a></td>
87 <td>Public method to read a file.</td>
88 </tr><tr>
83 <td><a href="#SyncHandler.shutdown">shutdown</a></td> 89 <td><a href="#SyncHandler.shutdown">shutdown</a></td>
84 <td>Public method to shut down the handler.</td> 90 <td>Public method to shut down the handler.</td>
85 </tr><tr> 91 </tr><tr>
86 <td><a href="#SyncHandler.syncBookmarks">syncBookmarks</a></td> 92 <td><a href="#SyncHandler.syncBookmarks">syncBookmarks</a></td>
87 <td>Public method to synchronize the bookmarks.</td> 93 <td>Public method to synchronize the bookmarks.</td>
92 <td><a href="#SyncHandler.syncPasswords">syncPasswords</a></td> 98 <td><a href="#SyncHandler.syncPasswords">syncPasswords</a></td>
93 <td>Public method to synchronize the passwords.</td> 99 <td>Public method to synchronize the passwords.</td>
94 </tr><tr> 100 </tr><tr>
95 <td><a href="#SyncHandler.syncUserAgents">syncUserAgents</a></td> 101 <td><a href="#SyncHandler.syncUserAgents">syncUserAgents</a></td>
96 <td>Public method to synchronize the user agents.</td> 102 <td>Public method to synchronize the user agents.</td>
103 </tr><tr>
104 <td><a href="#SyncHandler.writeFile">writeFile</a></td>
105 <td>Public method to write the data to a file.</td>
97 </tr> 106 </tr>
98 </table> 107 </table>
99 <h3>Static Methods</h3> 108 <h3>Static Methods</h3>
100 <table> 109 <table>
101 <tr><td>None</td></tr> 110 <tr><td>None</td></tr>
110 <dd> 119 <dd>
111 reference to the parent object (QObject) 120 reference to the parent object (QObject)
112 </dd> 121 </dd>
113 </dl><a NAME="SyncHandler.initialLoadAndCheck" ID="SyncHandler.initialLoadAndCheck"></a> 122 </dl><a NAME="SyncHandler.initialLoadAndCheck" ID="SyncHandler.initialLoadAndCheck"></a>
114 <h4>SyncHandler.initialLoadAndCheck</h4> 123 <h4>SyncHandler.initialLoadAndCheck</h4>
115 <b>initialLoadAndCheck</b>(<i></i>) 124 <b>initialLoadAndCheck</b>(<i>forceUpload</i>)
116 <p> 125 <p>
117 Public method to do the initial check. 126 Public method to do the initial check.
118 </p><a NAME="SyncHandler.shutdown" ID="SyncHandler.shutdown"></a> 127 </p><dl>
128 <dt><i>forceUpload=</i></dt>
129 <dd>
130 flag indicating a forced upload of the files (boolean)
131 </dd>
132 </dl><a NAME="SyncHandler.readFile" ID="SyncHandler.readFile"></a>
133 <h4>SyncHandler.readFile</h4>
134 <b>readFile</b>(<i>fileName</i>)
135 <p>
136 Public method to read a file.
137 </p><p>
138 If encrypted synchronization is enabled, the data will be encrypted using
139 the relevant encryption key.
140 </p><dl>
141 <dt><i>fileName</i></dt>
142 <dd>
143 name of the file to be read (string)
144 </dd>
145 </dl><dl>
146 <dt>Returns:</dt>
147 <dd>
148 data of the file, optionally encrypted (QByteArray)
149 </dd>
150 </dl><a NAME="SyncHandler.shutdown" ID="SyncHandler.shutdown"></a>
119 <h4>SyncHandler.shutdown</h4> 151 <h4>SyncHandler.shutdown</h4>
120 <b>shutdown</b>(<i></i>) 152 <b>shutdown</b>(<i></i>)
121 <p> 153 <p>
122 Public method to shut down the handler. 154 Public method to shut down the handler.
123 </p><a NAME="SyncHandler.syncBookmarks" ID="SyncHandler.syncBookmarks"></a> 155 </p><a NAME="SyncHandler.syncBookmarks" ID="SyncHandler.syncBookmarks"></a>
138 </p><a NAME="SyncHandler.syncUserAgents" ID="SyncHandler.syncUserAgents"></a> 170 </p><a NAME="SyncHandler.syncUserAgents" ID="SyncHandler.syncUserAgents"></a>
139 <h4>SyncHandler.syncUserAgents</h4> 171 <h4>SyncHandler.syncUserAgents</h4>
140 <b>syncUserAgents</b>(<i></i>) 172 <b>syncUserAgents</b>(<i></i>)
141 <p> 173 <p>
142 Public method to synchronize the user agents. 174 Public method to synchronize the user agents.
143 </p> 175 </p><a NAME="SyncHandler.writeFile" ID="SyncHandler.writeFile"></a>
176 <h4>SyncHandler.writeFile</h4>
177 <b>writeFile</b>(<i>data, fileName</i>)
178 <p>
179 Public method to write the data to a file.
180 </p><p>
181 If encrypted synchronization is enabled, the data will be decrypted using
182 the relevant encryption key.
183 </p><dl>
184 <dt><i>data</i></dt>
185 <dd>
186 data to be written and optionally decrypted (QByteArray)
187 </dd><dt><i>fileName</i></dt>
188 <dd>
189 name of the file the data is to be written to (string)
190 </dd>
191 </dl><dl>
192 <dt>Returns:</dt>
193 <dd>
194 tuple giving a success flag and an error string (boolean, string)
195 </dd>
196 </dl>
144 <div align="right"><a href="#top">Up</a></div> 197 <div align="right"><a href="#top">Up</a></div>
145 <hr /> 198 <hr />
146 </body></html> 199 </body></html>

eric ide

mercurial