272 lines
9.1 KiB
ReStructuredText
272 lines
9.1 KiB
ReStructuredText
|
Event Index
|
||
|
|
===========
|
||
|
|
|
||
|
|
.. glossary::
|
||
|
|
:sorted:
|
||
|
|
|
||
|
|
connected
|
||
|
|
- **Data:** ``{}``
|
||
|
|
- **Source:** :py:class:`~sleekxmpp.clientxmpp.ClientXMPP`
|
||
|
|
|
||
|
|
Signal that a connection has been made with the XMPP server, but a session
|
||
|
|
has not yet been established.
|
||
|
|
|
||
|
|
changed_status
|
||
|
|
- **Data:** :py:class:`~sleekxmpp.Presence`
|
||
|
|
- **Source:** :py:class:`~sleekxmpp.BaseXMPP`
|
||
|
|
|
||
|
|
Triggered when a presence stanza is received from a JID with a show type
|
||
|
|
different than the last presence stanza from the same JID.
|
||
|
|
|
||
|
|
changed_subscription
|
||
|
|
- **Data:** :py:class:`~sleekxmpp.Presence`
|
||
|
|
- **Source:** :py:class:`~sleekxmpp.BaseXMPP`
|
||
|
|
|
||
|
|
Triggered whenever a presence stanza with a type of ``subscribe``,
|
||
|
|
``subscribed``, ``unsubscribe``, or ``unsubscribed`` is received.
|
||
|
|
|
||
|
|
Note that if the values ``xmpp.auto_authorize`` and ``xmpp.auto_subscribe``
|
||
|
|
are set to ``True`` or ``False``, and not ``None``, then SleekXMPP will
|
||
|
|
either accept or reject all subscription requests before your event handlers
|
||
|
|
are called. Set these values to ``None`` if you wish to make more complex
|
||
|
|
subscription decisions.
|
||
|
|
|
||
|
|
chatstate_active
|
||
|
|
- **Data:**
|
||
|
|
- **Source:**
|
||
|
|
|
||
|
|
chatstate_composing
|
||
|
|
- **Data:**
|
||
|
|
- **Source:**
|
||
|
|
|
||
|
|
chatstate_gone
|
||
|
|
- **Data:**
|
||
|
|
- **Source:**
|
||
|
|
|
||
|
|
chatstate_inactive
|
||
|
|
- **Data:**
|
||
|
|
- **Source:**
|
||
|
|
|
||
|
|
chatstate_paused
|
||
|
|
- **Data:**
|
||
|
|
- **Source:**
|
||
|
|
|
||
|
|
disco_info
|
||
|
|
- **Data:** :py:class:`~sleekxmpp.plugins.xep_0030.stanza.DiscoInfo`
|
||
|
|
- **Source:** :py:class:`~sleekxmpp.plugins.xep_0030.disco.xep_0030`
|
||
|
|
|
||
|
|
Triggered whenever a ``disco#info`` result stanza is received.
|
||
|
|
|
||
|
|
disco_items
|
||
|
|
- **Data:** :py:class:`~sleekxmpp.plugins.xep_0030.stanza.DiscoItems`
|
||
|
|
- **Source:** :py:class:`~sleekxmpp.plugins.xep_0030.disco.xep_0030`
|
||
|
|
|
||
|
|
Triggered whenever a ``disco#items`` result stanza is received.
|
||
|
|
|
||
|
|
disconnected
|
||
|
|
- **Data:** ``{}``
|
||
|
|
- **Source:** :py:class:`~sleekxmpp.ClientXMPP`
|
||
|
|
|
||
|
|
Signal that the connection with the XMPP server has been lost.
|
||
|
|
|
||
|
|
entity_time
|
||
|
|
- **Data:**
|
||
|
|
- **Source:**
|
||
|
|
|
||
|
|
failed_auth
|
||
|
|
- **Data:** ``{}``
|
||
|
|
- **Source:** :py:class:`~sleekxmpp.ClientXMPP`, :py:class:`~sleekxmpp.plugins.xep_0078.xep_0078`
|
||
|
|
|
||
|
|
Signal that the server has rejected the provided login credentials.
|
||
|
|
|
||
|
|
gmail_notify
|
||
|
|
- **Data:** ``{}``
|
||
|
|
- **Source:** :py:class:`~sleekxmpp.plugins.gmail_notify.gmail_notify`
|
||
|
|
|
||
|
|
Signal that there are unread emails for the Gmail account associated with the current XMPP account.
|
||
|
|
|
||
|
|
gmail_messages
|
||
|
|
- **Data:** :py:class:`~sleekxmpp.Iq`
|
||
|
|
- **Source:** :py:class:`~sleekxmpp.plugins.gmail_notify.gmail_notify`
|
||
|
|
|
||
|
|
Signal that there are unread emails for the Gmail account associated with the current XMPP account.
|
||
|
|
|
||
|
|
got_online
|
||
|
|
- **Data:** :py:class:`~sleekxmpp.Presence`
|
||
|
|
- **Source:** :py:class:`~sleekxmpp.BaseXMPP`
|
||
|
|
|
||
|
|
If a presence stanza is received from a JID which was previously marked as
|
||
|
|
offline, and the presence has a show type of '``chat``', '``dnd``', '``away``',
|
||
|
|
or '``xa``', then this event is triggered as well.
|
||
|
|
|
||
|
|
got_offline
|
||
|
|
- **Data:** :py:class:`~sleekxmpp.Presence`
|
||
|
|
- **Source:** :py:class:`~sleekxmpp.BaseXMPP`
|
||
|
|
|
||
|
|
Signal that an unavailable presence stanza has been received from a JID.
|
||
|
|
|
||
|
|
groupchat_invite
|
||
|
|
- **Data:**
|
||
|
|
- **Source:**
|
||
|
|
|
||
|
|
groupchat_direct_invite
|
||
|
|
- **Data:** :py:class:`~sleekxmpp.Message`
|
||
|
|
- **Source:** :py:class:`~sleekxmpp.plugins.xep_0249.direct`
|
||
|
|
|
||
|
|
groupchat_message
|
||
|
|
- **Data:** :py:class:`~sleekxmpp.Message`
|
||
|
|
- **Source:** :py:class:`~sleekxmpp.plugins.xep_0045.xep_0045`
|
||
|
|
|
||
|
|
Triggered whenever a message is received from a multi-user chat room.
|
||
|
|
|
||
|
|
groupchat_presence
|
||
|
|
- **Data:** :py:class:`~sleekxmpp.Presence`
|
||
|
|
- **Source:** :py:class:`~sleekxmpp.plugins.xep_0045.xep_0045`
|
||
|
|
|
||
|
|
Triggered whenever a presence stanza is received from a user in a multi-user chat room.
|
||
|
|
|
||
|
|
groupchat_subject
|
||
|
|
- **Data:** :py:class:`~sleekxmpp.Message`
|
||
|
|
- **Source:** :py:class:`~sleekxmpp.plugins.xep_0045.xep_0045`
|
||
|
|
|
||
|
|
Triggered whenever the subject of a multi-user chat room is changed, or announced when joining a room.
|
||
|
|
|
||
|
|
killed
|
||
|
|
- **Data:**
|
||
|
|
- **Source:**
|
||
|
|
|
||
|
|
last_activity
|
||
|
|
- **Data:**
|
||
|
|
- **Source:**
|
||
|
|
|
||
|
|
message
|
||
|
|
- **Data:** :py:class:`~sleekxmpp.Message`
|
||
|
|
- **Source:** :py:class:`BaseXMPP <sleekxmpp.BaseXMPP>`
|
||
|
|
|
||
|
|
Makes the contents of message stanzas available whenever one is received. Be
|
||
|
|
sure to check the message type in order to handle error messages.
|
||
|
|
|
||
|
|
message_form
|
||
|
|
- **Data:** :py:class:`~sleekxmpp.plugins.xep_0004.Form`
|
||
|
|
- **Source:** :py:class:`~sleekxmpp.plugins.xep_0004.xep_0004`
|
||
|
|
|
||
|
|
Currently the same as :term:`message_xform`.
|
||
|
|
|
||
|
|
message_xform
|
||
|
|
- **Data:** :py:class:`~sleekxmpp.plugins.xep_0004.Form`
|
||
|
|
- **Source:** :py:class:`~sleekxmpp.plugins.xep_0004.xep_0004`
|
||
|
|
|
||
|
|
Triggered whenever a data form is received inside a message.
|
||
|
|
|
||
|
|
mucc::[room]::got_offline
|
||
|
|
- **Data:**
|
||
|
|
- **Source:**
|
||
|
|
|
||
|
|
muc::[room]::got_online
|
||
|
|
- **Data:**
|
||
|
|
- **Source:**
|
||
|
|
|
||
|
|
muc::[room]::message
|
||
|
|
- **Data:**
|
||
|
|
- **Source:**
|
||
|
|
|
||
|
|
muc::[room]::presence
|
||
|
|
- **Data:**
|
||
|
|
- **Source:**
|
||
|
|
|
||
|
|
presence_available
|
||
|
|
- **Data:** :py:class:`~sleekxmpp.Presence`
|
||
|
|
- **Source:** :py:class:`~sleekxmpp.BaseXMPP`
|
||
|
|
|
||
|
|
A presence stanza with a type of '``available``' is received.
|
||
|
|
|
||
|
|
presence_error
|
||
|
|
- **Data:** :py:class:`~sleekxmpp.Presence`
|
||
|
|
- **Source:** :py:class:`~sleekxmpp.BaseXMPP`
|
||
|
|
|
||
|
|
A presence stanza with a type of '``error``' is received.
|
||
|
|
|
||
|
|
presence_form
|
||
|
|
- **Data:** :py:class:`~sleekxmpp.plugins.xep_0004.Form`
|
||
|
|
- **Source:** :py:class:`~sleekxmpp.plugins.xep_0004.xep_0004`
|
||
|
|
|
||
|
|
This event is present in the XEP-0004 plugin code, but is currently not used.
|
||
|
|
|
||
|
|
presence_probe
|
||
|
|
- **Data:** :py:class:`~sleekxmpp.Presence`
|
||
|
|
- **Source:** :py:class:`~sleekxmpp.BaseXMPP`
|
||
|
|
|
||
|
|
A presence stanza with a type of '``probe``' is received.
|
||
|
|
|
||
|
|
presence_subscribe
|
||
|
|
- **Data:** :py:class:`~sleekxmpp.Presence`
|
||
|
|
- **Source:** :py:class:`~sleekxmpp.BaseXMPP`
|
||
|
|
|
||
|
|
A presence stanza with a type of '``subscribe``' is received.
|
||
|
|
|
||
|
|
presence_subscribed
|
||
|
|
- **Data:** :py:class:`~sleekxmpp.Presence`
|
||
|
|
- **Source:** :py:class:`~sleekxmpp.BaseXMPP`
|
||
|
|
|
||
|
|
A presence stanza with a type of '``subscribed``' is received.
|
||
|
|
|
||
|
|
presence_unavailable
|
||
|
|
- **Data:** :py:class:`~sleekxmpp.Presence`
|
||
|
|
- **Source:** :py:class:`~sleekxmpp.BaseXMPP`
|
||
|
|
|
||
|
|
A presence stanza with a type of '``unavailable``' is received.
|
||
|
|
|
||
|
|
presence_unsubscribe
|
||
|
|
- **Data:** :py:class:`~sleekxmpp.Presence`
|
||
|
|
- **Source:** :py:class:`~sleekxmpp.BaseXMPP`
|
||
|
|
|
||
|
|
A presence stanza with a type of '``unsubscribe``' is received.
|
||
|
|
|
||
|
|
presence_unsubscribed
|
||
|
|
- **Data:** :py:class:`~sleekxmpp.Presence`
|
||
|
|
- **Source:** :py:class:`~sleekxmpp.BaseXMPP`
|
||
|
|
|
||
|
|
A presence stanza with a type of '``unsubscribed``' is received.
|
||
|
|
|
||
|
|
roster_update
|
||
|
|
- **Data:** :py:class:`~sleekxmpp.stanza.Roster`
|
||
|
|
- **Source:** :py:class:`~sleekxmpp.ClientXMPP`
|
||
|
|
|
||
|
|
An IQ result containing roster entries is received.
|
||
|
|
|
||
|
|
sent_presence
|
||
|
|
- **Data:** ``{}``
|
||
|
|
- **Source:** :py:class:`BaseXMPP <sleekxmpp.BaseXMPP>`
|
||
|
|
|
||
|
|
Signal that an initial presence stanza has been written to the XML stream.
|
||
|
|
|
||
|
|
session_end
|
||
|
|
- **Data:** ``{}``
|
||
|
|
- **Source:** :py:class:`ClientXMPP <sleekxmpp.ClientXMPP>`,
|
||
|
|
:py:class:`ComponentXMPP <sleekxmpp.ComponentXMPP>`
|
||
|
|
:py:class:`XEP-0078 <sleekxmpp.plugins.xep_0078>`
|
||
|
|
|
||
|
|
Signal that a connection to the XMPP server has been lost and the current
|
||
|
|
stream session has ended. Currently equivalent to :term:`disconnected`, but
|
||
|
|
future implementation of `XEP-0198: Stream Management <http://xmpp.org/extensions/xep-0198.html>`_
|
||
|
|
will distinguish the two events.
|
||
|
|
|
||
|
|
Plugins that maintain session-based state should clear themselves when
|
||
|
|
this event is fired.
|
||
|
|
|
||
|
|
session_start
|
||
|
|
- **Data:** ``{}``
|
||
|
|
- **Source:** :py:class:`ClientXMPP <sleekxmpp.ClientXMPP>`,
|
||
|
|
:py:class:`ComponentXMPP <sleekxmpp.ComponentXMPP>`
|
||
|
|
:py:class:`XEP-0078 <sleekxmpp.plugins.xep_0078>`
|
||
|
|
|
||
|
|
Signal that a connection to the XMPP server has been made and a session has been established.
|
||
|
|
|
||
|
|
socket_error
|
||
|
|
- **Data:** ``Socket`` exception object
|
||
|
|
- **Source:** :py:class:`~sleekxmpp.xmlstream.XMLstream`
|
||
|
|
|
||
|
|
stream_error
|
||
|
|
- **Data:** :py:class:`~sleekxmpp.stanza.StreamError`
|
||
|
|
- **Source:** :py:class:`~sleekxmpp.BaseXMPP`
|