Mercurial > libervia-backend
view doc/jp/account.rst @ 3254:6cf4bd6972c2
core, frontends: avatar refactoring:
/!\ huge commit
Avatar logic has been reworked around the IDENTITY plugin: plugins able to handle avatar
or other identity related metadata (like nicknames) register to IDENTITY plugin in the
same way as for other features like download/upload. Once registered, IDENTITY plugin will
call them when suitable in order of priority, and handle caching.
Methods to manage those metadata from frontend now use serialised data.
For now `avatar` and `nicknames` are handled:
- `avatar` is now a dict with `path` + metadata like `media_type`, instead of just a string
path
- `nicknames` is now a list of nicknames in order of priority. This list is never empty,
and `nicknames[0]` should be the preferred nickname to use by frontends in most cases.
In addition to contact specified nicknames, user set nickname (the one set in roster) is
used in priority when available.
Among the side changes done with this commit, there are:
- a new `contactGet` bridge method to get roster metadata for a single contact
- SatPresenceProtocol.send returns a Deferred to check when it has actually been sent
- memory's methods to handle entities data now use `client` as first argument
- metadata filter can be specified with `getIdentity`
- `getAvatar` and `setAvatar` are now part of the IDENTITY plugin instead of XEP-0054 (and
there signature has changed)
- `isRoom` and `getBareOrFull` are now part of XEP-0045 plugin
- jp avatar/get command uses `xdg-open` first when available for `--show` flag
- `--no-cache` has been added to jp avatar/get and identity/get
- jp identity/set has been simplified, explicit options (`--nickname` only for now) are
used instead of `--field`. `--field` may come back in the future if necessary for extra
data.
- QuickContactList `SetContact` now handle None as a value, and doesn't use it to delete the
metadata anymore
- improved cache handling for `metadata` and `nicknames` in quick frontend
- new `default` argument in QuickContactList `getCache`
author | Goffi <goffi@goffi.org> |
---|---|
date | Tue, 14 Apr 2020 21:00:33 +0200 |
parents | 72583524cfd3 |
children |
line wrap: on
line source
================================ account: XMPP account management ================================ ``account`` command help you to create or manage the XMPP account of a server, using In-Band Registration (`XEP-0077`_). .. _XEP-0077: https://xmpp.org/extensions/xep-0077.html create ====== Create a XMPP account. You have to specify your jid and password as positional arguments. By default the registration is done on ``localhost`` with default XMPP Client 2 Server port (i.e. 5222), but you can specify other host/port using ``-H HOST, --host HOST`` and ``-P PORT, --port PORT``. You may also specify an e-mail address using ``-e EMAIL, --email EMAIL`` (use of this data depend of the server implementation). By default, no SàT profile is created and associated to this new XMPP account, but you can use ``-p PROFILE, --profile PROFILE`` if you are willing to have one. example ------- Create account for the new user Nestor at ``nestor@example.org`` and associate it with the SàT profile ``nestor``:: $ jp account create nestor@example.org some_password -p nestor modify ====== Modify an existing XMPP account password. This will modify the XMPP account linked to the given profile. .. note:: Only the XMPP password on the server is changed, not the one registered in the parameter of SàT. You may have to update the parameter of your profile if the new password doesn't correspond to your parameters one (you can do that with jp param set or with most SàT frontends in parameters). example ------- Change the XMPP password of the XMPP account of the default profile:: $ jp account modify new_password delete ====== Delete the XMPP account linked to the given profile from the XMPP server. Before using this command, please be sure to understand well that **THIS WILL REMOVE THE WHOLE XMPP ACCOUNT AND DATA FROM THE XMPP SERVER**. By default a confirmation is requested, you can do this without confirmation by using ``-f, --force``, however this is **NOT RECOMMENDED**, be sure to understand what you're doing if you use this option (and be sure to spell correctly the profile, if you forget the ``-p PROFILE, --profile`` argument for instance, this would delete entirely the default profile). .. note:: Be extra careful with this command, as it will remove the whole account from the server, and the associated data. example ------- Delete the XMPP account of Pierre, which is not on the local server anymore:: $ jp account delete -p pierre