diff doc/jp/identity.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 diff
--- a/doc/jp/identity.rst	Tue Apr 14 20:36:24 2020 +0200
+++ b/doc/jp/identity.rst	Tue Apr 14 21:00:33 2020 +0200
@@ -9,8 +9,11 @@
 ===
 
 Retrieve informations about the identity behind an XMPP entity. You only have to specify
-the jid of the entity, and you'll get (if set) his/her/its nickname and a link to the
-cached avatar.
+the jid of the entity, and you'll get (if set) his/her/its nickname and data about the
+avatar.
+
+When available, cached values are returned by defaut. If you want to ignore the cache, use
+the ``--no-cache`` option (of course this can result in more network requests).
 
 example
 --------
@@ -22,13 +25,12 @@
 set
 ===
 
-Set identity data to the server, using various XMPP extensions. You set the data to change
-using ``-f KEY VALUE, --field KEY VALUE``, where ``KEY`` can only be ``nick`` at the
-moment.
+Set identity data to the server, using various XMPP extensions. So far, you can only
+change the nickname of an entity using ``-n, --nick`` or or more times
 
 example
 -------
 
-Set the nickname of default profile::
+Set 2 nicknames for default profile::
 
-  $ jp identity set -f nick toto
+  $ jp identity set -n toto -n titi