diff options
| author | Hugo Hörnquist <hugo@lysator.liu.se> | 2021-12-12 23:29:06 +0100 |
|---|---|---|
| committer | Hugo Hörnquist <hugo@lysator.liu.se> | 2021-12-13 02:26:51 +0100 |
| commit | 5e4aa8e9aba34bb101923685c23f0f6681a12812 (patch) | |
| tree | 0bed50b63266ab65931a027c59e7b901f06d9d82 /doc/ref/javascript/server_connect.texi | |
| parent | Made VEventComponent template optional. (diff) | |
| download | calp-5e4aa8e9aba34bb101923685c23f0f6681a12812.tar.gz calp-5e4aa8e9aba34bb101923685c23f0f6681a12812.tar.xz | |
Add documenttation for javascript rewrite.
Diffstat (limited to 'doc/ref/javascript/server_connect.texi')
| -rw-r--r-- | doc/ref/javascript/server_connect.texi | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/doc/ref/javascript/server_connect.texi b/doc/ref/javascript/server_connect.texi index 2f50f02d..c67f47ff 100644 --- a/doc/ref/javascript/server_connect.texi +++ b/doc/ref/javascript/server_connect.texi @@ -1,2 +1,22 @@ @node server_connect @subsection server_connect.js + +Procedures for interfacing with the backend server. + +@deftypefn {Async Function} void create_event {event: VEvent} +Packs up the given event and sends it to the server to either be +created, or simply be updated in the persistant database. + +Also does some minor updates registered components, to show that the +event is actually created. +@end deftypefn + +@deftypefn {Async Function} void remove_event {uid: uid} +Requests that the server permanently remove the event with the given +unique id from its persistant storage. + +If the server responds with a success also delete it from our local +store (@code{vcal_objects}). + +@c TODO link to our backend flow here +@end deftypefn |