summaryrefslogtreecommitdiff
path: root/doc/source/misc/personal_events.rst
blob: 78bb1bc35c4c47fa6b8495147f87d492277117c0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
.. _pep-details:

Personal Events
===============

Starting from poezio 0.8, poezio now supports `user mood`_, `user activity`_,
`user tune`_, and `user gaming`_.

Those extensions are standardized ways to broadcast information that might be
useful to your contacts (they will receive those information only if they
have indicated their interest in them).

The events are also shown in the contact list, next to the contact line:

.. figure:: ../images/pep.png
    :alt: Personal Events

On the above figure, A stands for Activity, M for Mood, and G for Gaming.

The details are shown with notifications if configured, and in the detailed
contact information window, on the bottom left in the contact list tab.

.. figure:: ../images/pep_infos.png
    :alt: Personal Events details

You can see below the list of the related options and commands.

.. note::

    All the *display_foo_notifications* options can be tab-specific, so you
    can display those notifications only for a specific contact, or the
    other way around.


User Mood
~~~~~~~~~

Options:

- :term:`enable_user_mood`
- :term:`display_mood_notifications`

Commands:

- :term:`/mood`

User Activity
~~~~~~~~~~~~~

Options:

- :term:`enable_user_activity`
- :term:`display_activity_notifications`

Commands:

- :term:`/activity`

User Gaming
~~~~~~~~~~~

Options:

- :term:`enable_user_gaming`
- :term:`display_gaming_notifications`

Commands:

- :term:`/gaming`

User Tune
~~~~~~~~~

Options:

- :term:`enable_user_tune`
- :term:`display_tune_notifications`

.. note::

    There is no /tune command because it wouldn’t be really useful.
    There was originally a way to broadcast the current tune with the
    mpd plugin, but it was no good. You should use an external script
    to do that, or use a player that has the feature.

.. _user mood: http://xmpp.org/extensions/xep-0107.html
.. _user tune: http://xmpp.org/extensions/xep-0118.html
.. _user gaming: http://xmpp.org/extensions/xep-0197.html
.. _user activity: http://xmpp.org/extensions/xep-0108.html