Mercurial > libervia-backend
view doc/jp/event.rst @ 3123:130f9cb6e0ab
core (memory/params): added `extra` argument to filter out params notably in `getParamsUI`:
In some case, it may be desirable for a frontend to not expose some parameters to user
(e.g. it is the case on Android with the `autoconnect_backend` parameter). An new `extra`
parameter has been added to a couple of parameters method for that: it can contain the
`ignore` key with a list of [category, name] of parameters to skip.
author | Goffi <goffi@goffi.org> |
---|---|
date | Sat, 25 Jan 2020 21:08:40 +0100 |
parents | 72583524cfd3 |
children | 81c8910db91f |
line wrap: on
line source
======================== event: events management ======================== Event commands allows you to create/modify or get data about an event, and to manage your invitees. .. _jp-event_get: get === Get metadata about a specific event. example ------- Retrieve an event metadata:: $ jp event get -n org.salut-a-toi.event:0__BsyCsXpcrRh44CQhSVTUMi -i 'org.salut-a-toi.event:0' .. _jp-event_create: create ====== Create a new event. You can specify the date of the event with ``-d DATE, --date DATE``, and an id with ``-i ID, --id ID`` (default id is used if omitted). Configuration options are specified using ``-f KEY VALUE, --field KEY VALUE`` where key can be a custom data or one of: name name of the event description details of the event image URL of the main picture of the event background-image URL of image to use as background register a boolean value, set to ``true`` if you want to register the event in your local list example ------- Create an event about to celebrate New Year:: $ 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 modify ====== This command in the same way as jp-event_create_ but modify an existing event. You need to specify the node of the event to modify using ``-n NODE, --node NODE``. example ------- Add a background image to the New Year event created above:: $ jp event modify -n org.salut-a-toi.event:0__d8QQLJvbcpDXxK66UBXKfT -f background-image https://example.net/some_background_image.jpg invitee ======= Subcommands to handle guests. Please check :ref:`jp-event_invitee`.