Mercurial > libervia-backend
view doc/libervia-cli/notification.rst @ 4240:79c8a70e1813
backend, frontend: prepare remote control:
This is a series of changes necessary to prepare the implementation of remote control
feature:
- XEP-0166: add a `priority` attribute to `ApplicationData`: this is needed when several
applications are working in a same session, to know which one must be handled first.
Will be used to make Remote Control have precedence over Call content.
- XEP-0166: `_call_plugins` is now async and is not used with `DeferredList` anymore: the
benefit to have methods called in parallels is very low, and it cause a lot of trouble
as we can't predict order. Methods are now called sequentially so workflow can be
predicted.
- XEP-0167: fix `senders` XMPP attribute <=> SDP mapping
- XEP-0234: preflight acceptance key is now `pre-accepted` instead of `file-accepted`, so
the same key can be used with other jingle applications.
- XEP-0167, XEP-0343: move some method to XEP-0167
- XEP-0353: use new `priority` feature to call preflight methods of applications according
to it.
- frontend (webrtc): refactor the sources/sink handling with a more flexible mechanism
based on Pydantic models. It is now possible to have has many Data Channel as necessary,
to have them in addition to A/V streams, to specify manually GStreamer sources and
sinks, etc.
- frontend (webrtc): rework of the pipeline to reduce latency.
- frontend: new `portal_desktop` method. Screenshare portal handling has been moved there,
and RemoteDesktop portal has been added.
- frontend (webrtc): fix `extract_ufrag_pwd` method.
rel 436
| author | Goffi <goffi@goffi.org> |
|---|---|
| date | Sat, 11 May 2024 13:52:41 +0200 |
| parents | 646b328b3980 |
| children |
line wrap: on
line source
.. _libervia-cli_notification: ==================================== notification: notifications handling ==================================== Notifications can be retrieved, expired or created with the ``notification`` commands. add ==== Add and broadcast a new notification. Only admin profiles can add a notification. It can be used for service announcement, such as planned maintenance. To make an announcement to all profiles, use the ``-g, --is-global``. Note that such global notification aren't deleted when using :ref:`libervia-cli_notification_expire` command: you have either to use ``-e EXPIRE_AT, --expire-at EXPIRE_AT`` to set an expiration date, or to delete them manually with :ref:`libervia-cli_notification_delete`. example ------- Add a global service announcement to indicate that the server will be shut down. The expiration date is set so that the notification will be expired after expected end of maintenance:: $ li notification add service "Server will be shut down for maintenance." -P HIGH -g -e "2023-10-22" get === Retrieve notification for current profile. If ``-f, --follow`` argument is used, the CLI will continue to run and show any new incoming notification. examples -------- Louise wishes to obtain her current notifications and display any new notifications as they are issued:: $ li notification get -f Louise wants to see all her chat notifications which are at least of high priority (this includes urgent ones):: $ li notification get -t chat -P HIGH .. _libervia-cli_notification_delete: delete ====== Delete a notification by its ID. The notification must belong to the profile doing the request. If ``-g, --is-global`` is used, a global notification is to be deleted. Only admins can delete a global notification. example ------- Louise (who is an admin) wants to delete a previous global service announcement with ID ``123``:: $ li notification delete -g 123 .. _libervia-cli_notification_expire: expire ======= Delete expired notification (the ones with an expiration date set). If ``-l TIME_PATTERN, --limit TIME_PATTERN`` is used, also delete notification which have been **created** before the given limit. Some notifications can't be deleted this way: if they are global, or if they require a user action. Using ``now`` as time pattern will clear all the notifications that can be deleted. By default, only notifications of requesting profile are deleted (except for expired ones which are always deleted). If ``-a, --all`` is used, notification for all profiles can be deleted. This option is notably useful to schedule automatic notification cleaning. example ------- Louise want to expire notification for all profiles that are older than 7 days:: $ li notification expire -a -l "7 days ago"