mirrors/TiddlyWiki5
1
0
Fork 0
mirror of https://github.com/Jermolene/TiddlyWiki5 synced 2024-11-27 12:07:19 +00:00
Code Issues Releases Wiki Activity

Docs update

Browse Source
This commit is contained in:
Jeremy Ruston 2013-03-24 12:21:13 +00:00
parent 2870a09dc1
commit 6eb48e7058
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
editions/tw5.com/tiddlers/moduletypes/SyncAdaptorModules.tid
View File

@ -42,14 +42,14 @@ Returns an object storing any additional information required by the adaptor.
!! `getStatus(callback)` !! `getStatus(callback)`
Retrieves status information from the server. Retrieves status information from the server. This method is optional.
|!Parameter |!Description | |!Parameter |!Description |
|callback |Callback function invoked with parameters `err,isLoggedIn,username` | |callback |Callback function invoked with parameters `err,isLoggedIn,username` |
!! `login(username,password,callback)` !! `login(username,password,callback)`
Attempts to login to the server with specified credentials. Attempts to login to the server with specified credentials. This method is optional.
|!Parameter |!Description | |!Parameter |!Description |
|username |Username | |username |Username |
@ -58,7 +58,7 @@ Attempts to login to the server with specified credentials.
!! `logout(callback)` !! `logout(callback)`
Attempts to logout of the server. Attempts to logout of the server. This method is optional.
|!Parameter |!Description | |!Parameter |!Description |
|callback |Callback function invoked with parameter `err` | |callback |Callback function invoked with parameter `err` |
@ -67,6 +67,8 @@ Attempts to logout of the server.
Retrieves a list of skinny tiddlers from the server. Retrieves a list of skinny tiddlers from the server.
This method is optional. If an adaptor doesn't implement it then synchronisation will be unidirectional from the TiddlyWiki store to the adaptor, but not the other way.
|!Parameter |!Description | |!Parameter |!Description |
|callback |Callback function invoked with parameter `err,tiddlers`, where `tiddlers` is an array of tiddler field objects | |callback |Callback function invoked with parameter `err,tiddlers`, where `tiddlers` is an array of tiddler field objects |