diff options
| author | mathieui <mathieui@mathieui.net> | 2021-02-14 11:47:20 +0100 |
|---|---|---|
| committer | mathieui <mathieui@mathieui.net> | 2021-02-26 00:08:56 +0100 |
| commit | f7ecce42ac953dc358fd2385720fea21fb8406d7 (patch) | |
| tree | 88136852cf1f1e1a234dd826ea3c0aa27bdf523c /docs/api/plugins | |
| parent | d17967f58e05b090c4973cee320792dd82db2513 (diff) | |
| download | slixmpp-f7ecce42ac953dc358fd2385720fea21fb8406d7.tar.gz slixmpp-f7ecce42ac953dc358fd2385720fea21fb8406d7.tar.bz2 slixmpp-f7ecce42ac953dc358fd2385720fea21fb8406d7.tar.xz slixmpp-f7ecce42ac953dc358fd2385720fea21fb8406d7.zip | |
XEP-0054: API changes
- ``get_vcard``, ``publish_vcard`` are now coroutines.
Diffstat (limited to 'docs/api/plugins')
| -rw-r--r-- | docs/api/plugins/xep_0054.rst | 32 |
1 files changed, 32 insertions, 0 deletions
diff --git a/docs/api/plugins/xep_0054.rst b/docs/api/plugins/xep_0054.rst index db8e29ef..f9c964a8 100644 --- a/docs/api/plugins/xep_0054.rst +++ b/docs/api/plugins/xep_0054.rst @@ -8,6 +8,38 @@ XEP-0054: vcard-temp :members: :exclude-members: session_bind, plugin_init, plugin_end +Internal API methods +-------------------- + +This plugin maintains by default an in-memory cache of the received +VCards. + +.. glossary:: + + set_vcard + - **jid**: :class:`~.JID` of whom to set the vcard + - **node**: unused + - **ifrom**: unused + - **args**: :class:`~.VCardTemp` object to store for this JID. + + Set a VCard for a JID. + + get_vcard + - **jid**: :class:`~.JID` of whom to set the vcard + - **node**: unused + - **ifrom**: :class:`~.JID` the request is coming from + - **args**: unused + - **returns**: :class:`~.VCardTemp` object for this JID or None. + + Get a stored VCard for a JID. + + del_vcard + - **jid**: :class:`~.JID` of whom to set the vcard + - **node**: unused + - **ifrom**: unused + - **args**: unused + + Delete a stored VCard for a JID. Stanza elements --------------- |