docs/event_index.rst

   1 Event Index
   2 ===========
   3
   4 .. glossary::
   5     :sorted:
   6
   7     connected
   8         - **Data:** ``{}``
   9         - **Source:** :py:class:`~slixmpp.xmlstream.XMLstream`
  10
  11         Signal that a connection has been made with the XMPP server, but a session
  12         has not yet been established.
  13
  14     connection_failed
  15         - **Data:** ``{}`` or ``Failure Stanza`` if available
  16         - **Source:** :py:class:`~slixmpp.xmlstream.XMLstream`
  17
  18         Signal that a connection can not be established after number of attempts.
  19
  20     changed_status
  21         - **Data:** :py:class:`~slixmpp.Presence`
  22         - **Source:** :py:class:`~slixmpp.roster.item.RosterItem`
  23
  24         Triggered when a presence stanza is received from a JID with a show type
  25         different than the last presence stanza from the same JID.
  26
  27     changed_subscription
  28         - **Data:** :py:class:`~slixmpp.Presence`
  29         - **Source:** :py:class:`~slixmpp.BaseXMPP`
  30
  31         Triggered whenever a presence stanza with a type of ``subscribe``,
  32         ``subscribed``, ``unsubscribe``, or ``unsubscribed`` is received.
  33
  34         Note that if the values ``xmpp.auto_authorize`` and ``xmpp.auto_subscribe``
  35         are set to ``True`` or ``False``, and not ``None``, then Slixmpp will
  36         either accept or reject all subscription requests before your event handlers
  37         are called. Set these values to ``None`` if you wish to make more complex
  38         subscription decisions.
  39
  40     chatstate_active
  41         - **Data:**
  42         - **Source:**
  43
  44     chatstate_composing
  45         - **Data:**
  46         - **Source:**
  47
  48     chatstate_gone
  49         - **Data:**
  50         - **Source:**
  51
  52     chatstate_inactive
  53         - **Data:**
  54         - **Source:**
  55
  56     chatstate_paused
  57         - **Data:**
  58         - **Source:**
  59
  60     disco_info
  61         - **Data:** :py:class:`~slixmpp.plugins.xep_0030.stanza.DiscoInfo`
  62         - **Source:** :py:class:`~slixmpp.plugins.xep_0030.disco.xep_0030`
  63
  64         Triggered whenever a ``disco#info`` result stanza is received.
  65
  66     disco_items
  67         - **Data:** :py:class:`~slixmpp.plugins.xep_0030.stanza.DiscoItems`
  68         - **Source:** :py:class:`~slixmpp.plugins.xep_0030.disco.xep_0030`
  69
  70         Triggered whenever a ``disco#items`` result stanza is received.
  71
  72     disconnected
  73         - **Data:** ``{}``
  74         - **Source:** :py:class:`~slixmpp.xmlstream.XMLstream`
  75
  76         Signal that the connection with the XMPP server has been lost.
  77
  78     entity_time
  79         - **Data:**
  80         - **Source:**
  81
  82     failed_auth
  83         - **Data:** ``{}``
  84         - **Source:** :py:class:`~slixmpp.ClientXMPP`, :py:class:`~slixmpp.plugins.xep_0078.xep_0078`
  85
  86         Signal that the server has rejected the provided login credentials.
  87
  88     gmail_notify
  89         - **Data:** ``{}``
  90         - **Source:** :py:class:`~slixmpp.plugins.gmail_notify.gmail_notify`
  91
  92         Signal that there are unread emails for the Gmail account associated with the current XMPP account.
  93
  94     gmail_messages
  95         - **Data:** :py:class:`~slixmpp.Iq`
  96         - **Source:** :py:class:`~slixmpp.plugins.gmail_notify.gmail_notify`
  97
  98         Signal that there are unread emails for the Gmail account associated with the current XMPP account.
  99
 100     got_online
 101         - **Data:** :py:class:`~slixmpp.Presence`
 102         - **Source:** :py:class:`~slixmpp.roster.item.RosterItem`
 103
 104         If a presence stanza is received from a JID which was previously marked as
 105         offline, and the presence has a show type of '``chat``', '``dnd``', '``away``',
 106         or '``xa``', then this event is triggered as well.
 107
 108     got_offline
 109         - **Data:** :py:class:`~slixmpp.Presence`
 110         - **Source:** :py:class:`~slixmpp.roster.item.RosterItem`
 111
 112         Signal that an unavailable presence stanza has been received from a JID.
 113
 114     groupchat_invite
 115         - **Data:**
 116         - **Source:**
 117
 118     groupchat_direct_invite
 119         - **Data:** :py:class:`~slixmpp.Message`
 120         - **Source:** :py:class:`~slixmpp.plugins.xep_0249.direct`
 121
 122     groupchat_message
 123         - **Data:** :py:class:`~slixmpp.Message`
 124         - **Source:** :py:class:`~slixmpp.plugins.xep_0045.xep_0045`
 125
 126         Triggered whenever a message is received from a multi-user chat room.
 127
 128     groupchat_presence
 129         - **Data:** :py:class:`~slixmpp.Presence`
 130         - **Source:** :py:class:`~slixmpp.plugins.xep_0045.xep_0045`
 131
 132         Triggered whenever a presence stanza is received from a user in a multi-user chat room.
 133
 134     groupchat_subject
 135         - **Data:** :py:class:`~slixmpp.Message`
 136         - **Source:** :py:class:`~slixmpp.plugins.xep_0045.xep_0045`
 137
 138         Triggered whenever the subject of a multi-user chat room is changed, or announced when joining a room.
 139
 140     killed
 141         - **Data:**
 142         - **Source:**
 143
 144     last_activity
 145         - **Data:**
 146         - **Source:**
 147
 148     message
 149         - **Data:** :py:class:`~slixmpp.Message`
 150         - **Source:** :py:class:`BaseXMPP <slixmpp.BaseXMPP>`
 151
 152         Makes the contents of message stanzas available whenever one is received. Be
 153         sure to check the message type in order to handle error messages.
 154
 155     message_form
 156         - **Data:** :py:class:`~slixmpp.plugins.xep_0004.Form`
 157         - **Source:** :py:class:`~slixmpp.plugins.xep_0004.xep_0004`
 158
 159         Currently the same as :term:`message_xform`.
 160
 161     message_xform
 162         - **Data:** :py:class:`~slixmpp.plugins.xep_0004.Form`
 163         - **Source:** :py:class:`~slixmpp.plugins.xep_0004.xep_0004`
 164
 165         Triggered whenever a data form is received inside a message.
 166
 167     muc::[room]::got_offline
 168         - **Data:**
 169         - **Source:**
 170
 171     muc::[room]::got_online
 172         - **Data:**
 173         - **Source:**
 174
 175     muc::[room]::message
 176         - **Data:**
 177         - **Source:**
 178
 179     muc::[room]::presence
 180         - **Data:**
 181         - **Source:**
 182
 183     presence_available
 184         - **Data:** :py:class:`~slixmpp.Presence`
 185         - **Source:** :py:class:`~slixmpp.BaseXMPP`
 186
 187         A presence stanza with a type of '``available``' is received.
 188
 189     presence_error
 190         - **Data:** :py:class:`~slixmpp.Presence`
 191         - **Source:** :py:class:`~slixmpp.BaseXMPP`
 192
 193         A presence stanza with a type of '``error``' is received.
 194
 195     presence_form
 196         - **Data:** :py:class:`~slixmpp.plugins.xep_0004.Form`
 197         - **Source:** :py:class:`~slixmpp.plugins.xep_0004.xep_0004`
 198
 199         This event is present in the XEP-0004 plugin code, but is currently not used.
 200
 201     presence_probe
 202         - **Data:** :py:class:`~slixmpp.Presence`
 203         - **Source:** :py:class:`~slixmpp.BaseXMPP`
 204
 205         A presence stanza with a type of '``probe``' is received.
 206
 207     presence_subscribe
 208         - **Data:** :py:class:`~slixmpp.Presence`
 209         - **Source:** :py:class:`~slixmpp.BaseXMPP`
 210
 211         A presence stanza with a type of '``subscribe``' is received.
 212
 213     presence_subscribed
 214         - **Data:** :py:class:`~slixmpp.Presence`
 215         - **Source:** :py:class:`~slixmpp.BaseXMPP`
 216
 217         A presence stanza with a type of '``subscribed``' is received.
 218
 219     presence_unavailable
 220         - **Data:** :py:class:`~slixmpp.Presence`
 221         - **Source:** :py:class:`~slixmpp.BaseXMPP`
 222
 223         A presence stanza with a type of '``unavailable``' is received.
 224
 225     presence_unsubscribe
 226         - **Data:** :py:class:`~slixmpp.Presence`
 227         - **Source:** :py:class:`~slixmpp.BaseXMPP`
 228
 229         A presence stanza with a type of '``unsubscribe``' is received.
 230
 231     presence_unsubscribed
 232         - **Data:** :py:class:`~slixmpp.Presence`
 233         - **Source:** :py:class:`~slixmpp.BaseXMPP`
 234
 235         A presence stanza with a type of '``unsubscribed``' is received.
 236
 237     roster_update
 238         - **Data:** :py:class:`~slixmpp.stanza.Roster`
 239         - **Source:** :py:class:`~slixmpp.ClientXMPP`
 240
 241         An IQ result containing roster entries is received.
 242
 243     sent_presence
 244         - **Data:** ``{}``
 245         - **Source:** :py:class:`~slixmpp.roster.multi.Roster`
 246
 247         Signal that an initial presence stanza has been written to the XML stream.
 248
 249     session_end
 250         - **Data:** ``{}``
 251         - **Source:** :py:class:`~slixmpp.xmlstream.XMLstream`
 252
 253         Signal that a connection to the XMPP server has been lost and the current
 254         stream session has ended. Currently equivalent to :term:`disconnected`, but
 255         future implementation of `XEP-0198: Stream Management <http://xmpp.org/extensions/xep-0198.html>`_
 256         will distinguish the two events.
 257
 258         Plugins that maintain session-based state should clear themselves when
 259         this event is fired.
 260
 261     session_start
 262         - **Data:** ``{}``
 263         - **Source:** :py:class:`ClientXMPP <slixmpp.ClientXMPP>`,
 264           :py:class:`ComponentXMPP <slixmpp.ComponentXMPP>`
 265           :py:class:`XEP-0078 <slixmpp.plugins.xep_0078>`
 266
 267         Signal that a connection to the XMPP server has been made and a session has been established.
 268
 269     socket_error
 270         - **Data:** ``Socket`` exception object
 271         - **Source:** :py:class:`~slixmpp.xmlstream.XMLstream`
 272
 273     stream_error
 274         - **Data:** :py:class:`~slixmpp.stanza.StreamError`
 275         - **Source:** :py:class:`~slixmpp.BaseXMPP`