Mercurial > libervia-backend

comparison doc/libervia-cli/invitation.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/invitation.rst@c560aae54f5f
children 4705f80b6e23
comparison
equal deleted inserted replaced
3487:75427f0a5445 3488:c80a0f864b5d
1 ==============================================
2 invitation: invite people without XMPP account
3 ==============================================
4
5 Invitations allows you to invite people without XMPP account, so they can participate e.g.
6 to a discussion by using a specially generated link. This is a Salut à Toi specific
7 feature and those commands are rather low lever.
8
9 .. _libervia-cli_invitation_create:
10
11 create
12 ======
13
14 Invite somebody to participate. This will create a guest account and a link with an
15 identifier to access this account, and send an invitation to the given email.
16
17 The email is specified using ``-e EMAIL, --email EMAIL``, which can be used multiple times
18 to send the invitation to more than one address.
19
20 You'll usually want to specify the name of the person you're inviting, using ``-n NAME,
21 --name NAME``, it may later be used in email sent or in the web page where your guest will
22 land.
23
24 ``-N HOST_NAME, --host-name HOST_NAME`` is used to specify the name of yourself (i.e. the
25 person which is inviting), it may be used in invitation message.
26
27 You'll most of time have to specify the URL template using ``-u URL, --url URL``. This
28 will be used in the invitation email to construct the URL where your invitee will click.
29 You may use the string ``{{uuid}}`` in this template which will be replaced by the id
30 associated to the invitation. With Libervia, default invitation page is
31 ``<your_server>/g/<uuid>``.
32
33 The language of your guest can be specified using ``-l LANG, --lang LANG``, this is
34 notably useful if you have multilingual blog posts (e.g. for an event where people
35 speaking different languages are invited).
36
37 The ``-x KEY VALUE, --extra KEY VALUE`` is used for extra data which depend on what you
38 are inviting your guests for.
39
40
41 example
42 -------
43
44 Invite Louise, which is speaking French, to an event. The invitation is sent to her email
45 address ``louise_email@example.net``, is sent by Piotr, and must link to the Libervia
46 instance at ``https://www.example.org/g/<id>``. We use here the ``event_uri`` extra key::
47
48 $ li invitation create -n Louise -N Pierre -e louise_email@example.net -l fr -u "https://www.example.org/g/{uuid}" -x event_uri xmpp:pierre@example.org?;node=MnXe4ic2X8RUz6JAJuw4f9;item=org.salut-a-toi.event%3A0
49
50
51 get
52 ===
53
54 Get metadata for one specific invitation. You only have to specify the invitation id, and
55 you may use the option ``-j, --with-jid`` to also get the jid used for the invitation
56 (this will start the session of the invitee).
57
58 example
59 -------
60
61 Get invitation data for invitation with id ``okFec4gDz75My7iQAVTmsc``::
62
63 $ li invitation get okFec4gDz75My7iQAVTmsc -j
64
65
66 modify
67 ======
68
69 This work the same way as libervia-cli_invitation_create_, you only have to specify the ``id`` of the
70 invitation.
71
72 If you use the ``--replace`` argument, all the invitation data will be replaced by the
73 ones you're specifying.
74
75 example
76 -------
77
78 Change the language of the invitee for the invitation ``okFec4gDz75My7iQAVTmsc`` for
79 Slovak::
80
81 $ li invitation modify -l sk okFec4gDz75My7iQAVTmsc
82
83
84 delete
85 ======
86
87 Delete XMPP account created for an invitation and invitation data
88
89 example
90 -------
91
92 Delete invitation with id ``okFec4gDz75My7iQAVTmsc``::
93
94 $ li invitation delete okFec4gDz75My7iQAVTmsc
95
96
97 list
98 ====
99
100 List registered invitations. You may filter by the profile who made the invitation using
101 ``-p PROFILE, --profile PROFILE``.
102 The invitations are shown by default using id as main data, and metadata below.
103
104 example
105 -------
106
107 List invitations::
108
109 $ li invitation list