Mercurial > libervia-backend
comparison doc/jp/event.rst @ 3041:72583524cfd3
doc (jp): jp commands are now fully documented:
rel 232
| author | Goffi <goffi@goffi.org> |
|---|---|
| date | Tue, 01 Oct 2019 22:49:06 +0200 |
| parents | |
| children | 81c8910db91f |
comparison
equal
deleted
inserted
replaced
| 3040:fee60f17ebac | 3041:72583524cfd3 |
|---|---|
| 1 ======================== | |
| 2 event: events management | |
| 3 ======================== | |
| 4 | |
| 5 Event commands allows you to create/modify or get data about an event, and to manage your | |
| 6 invitees. | |
| 7 | |
| 8 .. _jp-event_get: | |
| 9 | |
| 10 get | |
| 11 === | |
| 12 | |
| 13 Get metadata about a specific event. | |
| 14 | |
| 15 example | |
| 16 ------- | |
| 17 | |
| 18 Retrieve an event metadata:: | |
| 19 | |
| 20 $ jp event get -n org.salut-a-toi.event:0__BsyCsXpcrRh44CQhSVTUMi -i 'org.salut-a-toi.event:0' | |
| 21 | |
| 22 .. _jp-event_create: | |
| 23 | |
| 24 create | |
| 25 ====== | |
| 26 | |
| 27 Create a new event. You can specify the date of the event with ``-d DATE, --date DATE``, | |
| 28 and an id with ``-i ID, --id ID`` (default id is used if omitted). | |
| 29 | |
| 30 Configuration options are specified using ``-f KEY VALUE, --field KEY VALUE`` where key | |
| 31 can be a custom data or one of: | |
| 32 | |
| 33 name | |
| 34 name of the event | |
| 35 description | |
| 36 details of the event | |
| 37 image | |
| 38 URL of the main picture of the event | |
| 39 background-image | |
| 40 URL of image to use as background | |
| 41 register | |
| 42 a boolean value, set to ``true`` if you want to register the event in your local list | |
| 43 | |
| 44 example | |
| 45 ------- | |
| 46 | |
| 47 Create an event about to celebrate New Year:: | |
| 48 | |
| 49 $ jp event create -d 2019-12-31 -f name "New Year's Eve" -f description "Party to celebrate new year" -f register true -f image https://example.net/some_image.jpg | |
| 50 | |
| 51 | |
| 52 modify | |
| 53 ====== | |
| 54 | |
| 55 This command in the same way as jp-event_create_ but modify an existing event. You need to | |
| 56 specify the node of the event to modify using ``-n NODE, --node NODE``. | |
| 57 | |
| 58 example | |
| 59 ------- | |
| 60 | |
| 61 Add a background image to the New Year event created above:: | |
| 62 | |
| 63 $ jp event modify -n org.salut-a-toi.event:0__d8QQLJvbcpDXxK66UBXKfT -f background-image https://example.net/some_background_image.jpg | |
| 64 | |
| 65 | |
| 66 invitee | |
| 67 ======= | |
| 68 | |
| 69 Subcommands to handle guests. Please check :ref:`jp-event_invitee`. |