Mercurial > libervia-backend

comparison doc/jp/event_invitee.rst @ 3041:72583524cfd3

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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
comparison
equal deleted inserted replaced
3040:fee60f17ebac 3041:72583524cfd3
1 .. _jp-event_invitee:
2
3 ========================================
4 event/invitee: event invitees management
5 ========================================
6
7 ``invitee`` groups commands to invite somebody to an event, get or set data about an invitee, and list all invitees. You can send an invitation by e-mail to people without XMPP account.
8
9 .. _jp-event_invitee_get:
10
11 get
12 ===
13
14 Retrieve the RSVP status of one guest. Note that you must the invitees node and not the
15 event node. To retrieve invitees node, use :ref:`jp-event_get` with the event node.
16
17 You may specify the guest bare jid using ``-j JID, --jid JID`` (by default your own bare
18 jid will be used).
19
20 If no response is known yet, no data is returned.
21
22 example
23 -------
24
25 Get RSVP of Louise::
26
27 $ jp event invitee get -u "xmpp:pierre@example.net?;node=generic%2F876a2b99-1c90-41fa-b823-c4a467140770" -j louise@example.org
28
29
30 .. _jp-event_invitee_set:
31
32 set
33 ===
34
35 Set your own RSVP data. Note that as for jp-event_invitee_get_ you must use
36 invitees node and not the event node.
37
38 Use ``-f KEY VALUE, --field KEY VALUE`` to specify the data to set. ``KEY`` can be one of
39 ``attend`` (where calue can be ``yes``, ``no``, or ``maybe``) and ``guests`` where value
40 must be an integer.
41
42 example
43 -------
44
45 Indicate that you'll come to an event with 3 guests::
46
47 $ jp event invitee set -u "xmpp:pierre@example.net?;node=generic%2F876a2b99-1c90-41fa-b823-c4a467140770" -f attend yes -f guests 3
48
49 list
50 ====
51
52 Get and format the RSVP of your invitees. Note that as for jp-event_invitee_get_ and
53 jp-event_invitee_set_ you must use invitees node and not the event node.
54
55 By default, only people who have answered are shown. You may use ``-m, --missing`` to show
56 other people which were invited, but have not answered yet. When using this option, you
57 can also use ``-R, --no-rsvp`` to only show people which have not answered yet.
58
59 You'll also have a small summary indicating how many people who can expect at your event.
60
61 example
62 -------
63
64 Get the full list of invitees (including those who didn't answered yet) with the RSVP formatted::
65
66 $ jp event invitee list -u "xmpp:pierre@example.net?;node=generic%2F876a2b99-1c90-41fa-b823-c4a467140770" -m
67
68 invite
69 ------
70
71 Invite somebody to an event. The invitation is done by e-mail, a guest account will be
72 created. Contrary to other ``invitee`` commands, in this one you'll use the event node
73 directly.
74
75 This command is really similar to :ref:`jp-invitation_create`
76
77 E-mail address is specified using ``-e EMAIL, --email EMAIL`` and you'll need to give an
78 URL template (using ``-U URL_TEMPLATE, --url-template URL_TEMPLATE``)leading to your
79 website page handling the invitation (for Libervia default invitation page is
80 ``<your_server>/g/<uuid>``). You can use ``{uuid}`` as a placeholder which will be
81 replaced by event's id.
82
83 You'll probably want to specify the name of the invitee, using ``-N NAME, --name NAME``
84 and your own name (as the host inviting), using ``-H HOST_NAME, --host-name HOST_NAME``.
85 The language spoken by your guest can be specified using ``-l LANG, --lang LANG``, it is
86 mainly useful if you have many invitee speaking different languages.
87
88 example
89 -------
90
91 Pierre is inviting Louise (whose e-mail address is ``louise_email@example.net``) to an
92 event he's organising::
93
94 $ jp event invitee invite -e louise_email@example.et -N "Louise" -H "Pierre" -l fr -U "https://www.example.org/g/{uuid}" -u "xmpp:pierre@example.org?;node=generic%2F61400ea7-a2a2-4ce0-9b68-3735b602f671"