Mercurial > libervia-backend
annotate doc/libervia-cli/event.rst @ 4119:ece304ec7077
plugin XEP-0167: fix key used to store metadata:
rel 424
author | Goffi <goffi@goffi.org> |
---|---|
date | Tue, 03 Oct 2023 15:18:25 +0200 |
parents | d6837db456fd |
children |
rev | line source |
---|---|
3041
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
1 ======================== |
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
2 event: events management |
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
3 ======================== |
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
4 |
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
5 Event commands allows you to create/modify or get data about an event, and to manage your |
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
6 invitees. |
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
7 |
3909
3c3275a6dc8f
doc (cli/event): update doc following changes:
Goffi <goffi@goffi.org>
parents:
3488
diff
changeset
|
8 get |
3c3275a6dc8f
doc (cli/event): update doc following changes:
Goffi <goffi@goffi.org>
parents:
3488
diff
changeset
|
9 === |
3276
81c8910db91f
jp (event): new `list` command to get evens available in a service
Goffi <goffi@goffi.org>
parents:
3041
diff
changeset
|
10 |
3909
3c3275a6dc8f
doc (cli/event): update doc following changes:
Goffi <goffi@goffi.org>
parents:
3488
diff
changeset
|
11 Get metadata about one or more event(s). |
3c3275a6dc8f
doc (cli/event): update doc following changes:
Goffi <goffi@goffi.org>
parents:
3488
diff
changeset
|
12 |
3c3275a6dc8f
doc (cli/event): update doc following changes:
Goffi <goffi@goffi.org>
parents:
3488
diff
changeset
|
13 By default the events are displayed in a format readable, and ``--verbose, -v`` can be |
3c3275a6dc8f
doc (cli/event): update doc following changes:
Goffi <goffi@goffi.org>
parents:
3488
diff
changeset
|
14 used one or more times to show more or less data. As usual, :ref:`libervia-cli_output` can |
3c3275a6dc8f
doc (cli/event): update doc following changes:
Goffi <goffi@goffi.org>
parents:
3488
diff
changeset
|
15 be used to get the data in a different way. |
3276
81c8910db91f
jp (event): new `list` command to get evens available in a service
Goffi <goffi@goffi.org>
parents:
3041
diff
changeset
|
16 |
81c8910db91f
jp (event): new `list` command to get evens available in a service
Goffi <goffi@goffi.org>
parents:
3041
diff
changeset
|
17 example |
81c8910db91f
jp (event): new `list` command to get evens available in a service
Goffi <goffi@goffi.org>
parents:
3041
diff
changeset
|
18 ------- |
81c8910db91f
jp (event): new `list` command to get evens available in a service
Goffi <goffi@goffi.org>
parents:
3041
diff
changeset
|
19 |
3909
3c3275a6dc8f
doc (cli/event): update doc following changes:
Goffi <goffi@goffi.org>
parents:
3488
diff
changeset
|
20 Retrieve events from personal agenda:: |
3276
81c8910db91f
jp (event): new `list` command to get evens available in a service
Goffi <goffi@goffi.org>
parents:
3041
diff
changeset
|
21 |
3909
3c3275a6dc8f
doc (cli/event): update doc following changes:
Goffi <goffi@goffi.org>
parents:
3488
diff
changeset
|
22 $ li event get |
3041
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
23 |
3909
3c3275a6dc8f
doc (cli/event): update doc following changes:
Goffi <goffi@goffi.org>
parents:
3488
diff
changeset
|
24 Get details of a next dentist appointment from personal agenda:: |
3041
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
25 |
3909
3c3275a6dc8f
doc (cli/event): update doc following changes:
Goffi <goffi@goffi.org>
parents:
3488
diff
changeset
|
26 $ li event get -i dentist -vv |
3041
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
27 |
3488
c80a0f864b5d
doc: updated doc following global renaming
Goffi <goffi@goffi.org>
parents:
3276
diff
changeset
|
28 .. _libervia-cli_event_create: |
3041
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
29 |
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
30 create |
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
31 ====== |
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
32 |
3909
3c3275a6dc8f
doc (cli/event): update doc following changes:
Goffi <goffi@goffi.org>
parents:
3488
diff
changeset
|
33 Create a new event. You can specify the starting time of the event with ``-S TIME_PATTERN, --start TIME_PATTERN``, and either its end time with ``-E TIME_PATTERN, --end TIME_PATTERN`` or its duration with ``-D DURATION, --duration DURATION``. ``--start`` and ``--end`` use a full :ref:`time_pattern` when ``--duration`` uses the relative delta part of it. It's mandatory when creating and event to specify starting and ending time (or duration). |
3041
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
34 |
3909
3c3275a6dc8f
doc (cli/event): update doc following changes:
Goffi <goffi@goffi.org>
parents:
3488
diff
changeset
|
35 If your organsise an item, the ``--rsvp`` flag should be used: it will use the default |
3c3275a6dc8f
doc (cli/event): update doc following changes:
Goffi <goffi@goffi.org>
parents:
3488
diff
changeset
|
36 RSVP form which ask for attendance. If you want to request more information to your guest, |
3c3275a6dc8f
doc (cli/event): update doc following changes:
Goffi <goffi@goffi.org>
parents:
3488
diff
changeset
|
37 ``--rsvp_json JSON`` can be used: the JSON argument is a data dict as described in |
4037
524856bd7b19
massive refactoring to switch from camelCase to snake_case:
Goffi <goffi@goffi.org>
parents:
3909
diff
changeset
|
38 ``data_dict_2_data_form`` function where the ``namespace`` key is not necessary (it's set |
3909
3c3275a6dc8f
doc (cli/event): update doc following changes:
Goffi <goffi@goffi.org>
parents:
3488
diff
changeset
|
39 automatically): |
3c3275a6dc8f
doc (cli/event): update doc following changes:
Goffi <goffi@goffi.org>
parents:
3488
diff
changeset
|
40 |
4077
d6837db456fd
refactoring: fix names in doc following modules hierarchy refactoring
Goffi <goffi@goffi.org>
parents:
4037
diff
changeset
|
41 .. autofunction:: libervia.backend.tools.xml_tools.data_dict_2_data_form |
3909
3c3275a6dc8f
doc (cli/event): update doc following changes:
Goffi <goffi@goffi.org>
parents:
3488
diff
changeset
|
42 |
3c3275a6dc8f
doc (cli/event): update doc following changes:
Goffi <goffi@goffi.org>
parents:
3488
diff
changeset
|
43 If the event links to an other one, ``--external JID NODE ITEM`` can be user |
3041
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
44 |
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
45 example |
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
46 ------- |
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
47 |
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
48 Create an event about to celebrate New Year:: |
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
49 |
3909
3c3275a6dc8f
doc (cli/event): update doc following changes:
Goffi <goffi@goffi.org>
parents:
3488
diff
changeset
|
50 $ li event create -s some_pubsub@example.net -n urn:xmpp:events:0/party -i new_year_eve_2022 --start 2022-12-31 --end 2023-01-01 -d "Party to celebrate new year" -H https://example.net/some_image.jpg "New Year's Eve" |
3c3275a6dc8f
doc (cli/event): update doc following changes:
Goffi <goffi@goffi.org>
parents:
3488
diff
changeset
|
51 |
3c3275a6dc8f
doc (cli/event): update doc following changes:
Goffi <goffi@goffi.org>
parents:
3488
diff
changeset
|
52 Add the dentist appointement on coming Tuesday to our personal agenda:: |
3c3275a6dc8f
doc (cli/event): update doc following changes:
Goffi <goffi@goffi.org>
parents:
3488
diff
changeset
|
53 |
3c3275a6dc8f
doc (cli/event): update doc following changes:
Goffi <goffi@goffi.org>
parents:
3488
diff
changeset
|
54 $ li event create -S tuesday -D "1 hour" Dentist |
3041
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
55 |
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
56 |
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
57 modify |
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
58 ====== |
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
59 |
3909
3c3275a6dc8f
doc (cli/event): update doc following changes:
Goffi <goffi@goffi.org>
parents:
3488
diff
changeset
|
60 This command works in the same way as libervia-cli_event_create_ but modify an existing |
3c3275a6dc8f
doc (cli/event): update doc following changes:
Goffi <goffi@goffi.org>
parents:
3488
diff
changeset
|
61 event: all arguments are optional, those specified will override the original ones from |
3c3275a6dc8f
doc (cli/event): update doc following changes:
Goffi <goffi@goffi.org>
parents:
3488
diff
changeset
|
62 the updated event. |
3c3275a6dc8f
doc (cli/event): update doc following changes:
Goffi <goffi@goffi.org>
parents:
3488
diff
changeset
|
63 |
3c3275a6dc8f
doc (cli/event): update doc following changes:
Goffi <goffi@goffi.org>
parents:
3488
diff
changeset
|
64 If the ending time or duration must be modified, the starting must be specified again. |
3041
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
65 |
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
66 example |
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
67 ------- |
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
68 |
3909
3c3275a6dc8f
doc (cli/event): update doc following changes:
Goffi <goffi@goffi.org>
parents:
3488
diff
changeset
|
69 Change the head picture from the New Year event created above:: |
3041
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
70 |
3909
3c3275a6dc8f
doc (cli/event): update doc following changes:
Goffi <goffi@goffi.org>
parents:
3488
diff
changeset
|
71 $ li event modify -s some_pubsub@example.net -n urn:xmpp:events:0/party -i new_year_eve_2022 -H https://example.net/some_other_image.jpg |
3041
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
72 |
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
73 |
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
74 invitee |
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
75 ======= |
72583524cfd3
doc (jp): jp commands are now fully documented:
Goffi <goffi@goffi.org>
parents:
diff
changeset
|
76 |
3488
c80a0f864b5d
doc: updated doc following global renaming
Goffi <goffi@goffi.org>
parents:
3276
diff
changeset
|
77 Subcommands to handle guests. Please check :ref:`libervia-cli_event_invitee`. |