Mercurial > libervia-backend

comparison doc/libervia-cli/event.rst @ 3488:c80a0f864b5d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
doc: updated doc following global renaming
author Goffi <goffi@goffi.org>
date Sun, 21 Mar 2021 18:23:58 +0100
parents doc/jp/event.rst@81c8910db91f
children 3c3275a6dc8f
comparison
equal deleted inserted replaced
3487:75427f0a5445 3488:c80a0f864b5d
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 list
9 ====
10
11 List events available on a service
12
13 example
14 -------
15
16 Retrieve events of profile::
17
18 $ li event list
19
20 .. _libervia-cli_event_get:
21
22 get
23 ===
24
25 Get metadata about a specific event.
26
27 example
28 -------
29
30 Retrieve an event metadata::
31
32 $ li event get -n org.salut-a-toi.event:0__BsyCsXpcrRh44CQhSVTUMi -i 'org.salut-a-toi.event:0'
33
34 .. _libervia-cli_event_create:
35
36 create
37 ======
38
39 Create a new event. You can specify the date of the event with ``-d DATE, --date DATE``,
40 and an id with ``-i ID, --id ID`` (default id is used if omitted).
41
42 Configuration options are specified using ``-f KEY VALUE, --field KEY VALUE`` where key
43 can be a custom data or one of:
44
45 name
46 name of the event
47 description
48 details of the event
49 image
50 URL of the main picture of the event
51 background-image
52 URL of image to use as background
53 register
54 a boolean value, set to ``true`` if you want to register the event in your local list
55
56 example
57 -------
58
59 Create an event about to celebrate New Year::
60
61 $ li 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
62
63
64 modify
65 ======
66
67 This command in the same way as libervia-cli_event_create_ but modify an existing event. You need to
68 specify the node of the event to modify using ``-n NODE, --node NODE``.
69
70 example
71 -------
72
73 Add a background image to the New Year event created above::
74
75 $ li event modify -n org.salut-a-toi.event:0__d8QQLJvbcpDXxK66UBXKfT -f background-image https://example.net/some_background_image.jpg
76
77
78 invitee
79 =======
80
81 Subcommands to handle guests. Please check :ref:`libervia-cli_event_invitee`.