Event Index

1.7 Documentation

«  Plugin Architecture   ::   Contents   ::   ClientXMPP  »

Event Index

attention
carbon_received
carbon_sent
changed_status
  • Data: Presence

  • Source: RosterItem

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: Presence

  • Source: 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 Slixmpp 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: Message

  • Source: xep_0085

chatstate_composing
  • Data: Message

  • Source: xep_0085

chatstate_gone
  • Data: Message

  • Source: xep_0085

chatstate_inactive
  • Data: Message

  • Source: xep_0085

chatstate_paused
  • Data: Message

  • Source: xep_0085

command
command_[action]
connected
  • Data: {}

  • Source: XMLstream

Signal that a connection has been made with the XMPP server, but a session has not yet been established.

connection_failed
  • Data: {} or Failure Stanza if available

  • Source: XMLstream

Signal that a connection can not be established after number of attempts.

disco_info
  • Data: DiscoInfo

  • Source: xep_0030

Triggered whenever a disco#info result stanza is received.

disco_items
  • Data: DiscoItems

  • Source: xep_0030

Triggered whenever a disco#items result stanza is received.

disconnected
  • Data: {}

  • Source: XMLstream

Signal that the connection with the XMPP server has been lost.

entity_time
  • Data:

  • Source:

failed_auth
  • Data: {}

  • Source: ClientXMPP, xep_0078

Signal that the server has rejected the provided login credentials.

gmail_messages
  • Data: Iq

  • Source: gmail_notify

Signal that there are unread emails for the Gmail account associated with the current XMPP account.

gmail_notify
  • Data: {}

  • Source: gmail_notify

Signal that there are unread emails for the Gmail account associated with the current XMPP account.

got_offline
  • Data: Presence

  • Source: RosterItem

Signal that an unavailable presence stanza has been received from a JID.

got_online
  • Data: Presence

  • Source: RosterItem

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.

groupchat_direct_invite
  • Data: Message

  • Source: direct

groupchat_invite
groupchat_message
  • Data: Message

  • Source: xep_0045

Triggered whenever a message is received from a multi-user chat room.

groupchat_presence
  • Data: Presence

  • Source: xep_0045

Triggered whenever a presence stanza is received from a user in a multi-user chat room.

groupchat_subject
  • Data: Message

  • Source: xep_0045

Triggered whenever the subject of a multi-user chat room is changed, or announced when joining a room.

ibb_stream_data
ibb_stream_end
ibb_stream_start
jingle_message_accept
jingle_message_proceed
jingle_message_propose
jingle_message_reject
jingle_message_retract
killed
  • Data:

  • Source:

last_activity
  • Data:

  • Source:

marker
marker_acknowledged
marker_displayed
marker_received
message
  • Data: Message

  • Source: 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_correction
message_error
  • Data: Message

  • Source: BaseXMPP

Makes the contents of message stanzas available whenever one is received. Only handler messages with an error type.

message_form
  • Data: Form

  • Source: xep_0004

Currently the same as message_xform.

message_xform
  • Data: Form

  • Source: xep_0004

Triggered whenever a data form is received inside a message.

muc::[room]::got_offline
muc::[room]::got_online
muc::[room]::message
muc::[room]::presence
presence_available
  • Data: Presence

  • Source: BaseXMPP

A presence stanza with a type of ‘available’ is received.

presence_error
  • Data: Presence

  • Source: BaseXMPP

A presence stanza with a type of ‘error’ is received.

presence_form
  • Data: Form

  • Source: xep_0004

This event is present in the XEP-0004 plugin code, but is currently not used.

presence_probe
  • Data: Presence

  • Source: BaseXMPP

A presence stanza with a type of ‘probe’ is received.

presence_subscribe
  • Data: Presence

  • Source: BaseXMPP

A presence stanza with a type of ‘subscribe’ is received.

presence_subscribed
  • Data: Presence

  • Source: BaseXMPP

A presence stanza with a type of ‘subscribed’ is received.

presence_unavailable
  • Data: Presence

  • Source: BaseXMPP

A presence stanza with a type of ‘unavailable’ is received.

presence_unsubscribe
  • Data: Presence

  • Source: BaseXMPP

A presence stanza with a type of ‘unsubscribe’ is received.

presence_unsubscribed
  • Data: Presence

  • Source: BaseXMPP

A presence stanza with a type of ‘unsubscribed’ is received.

pubsub_config
pubsub_delete
pubsub_publish
pubsub_purge
pubsub_retract
pubsub_subscription
reactions
receipt_received
room_activity
room_activity_bare
roster_update
  • Data: Roster

  • Source: ClientXMPP

An IQ result containing roster entries is received.

sent_presence
  • Data: {}

  • Source: Roster

Signal that an initial presence stanza has been written to the XML stream.

session_end
  • Data: {}

  • Source: XMLstream

Signal that a connection to the XMPP server has been lost and the current stream session has ended. Currently equivalent to disconnected, but implementations of XEP-0198: Stream Management distinguish between the two events.

Plugins that maintain session-based state should clear themselves when this event is fired.

session_start
  • Data: {}

  • Source: ClientXMPP, ComponentXMPP XEP-0078

Signal that a connection to the XMPP server has been made and a session has been established.

sm_disabled
sm_enabled
socket_error
  • Data: Socket exception object

  • Source: XMLstream

stream:[stream id]:[peer jid]
stream_error
  • Data: StreamError

  • Source: BaseXMPP

«  Plugin Architecture   ::   Contents   ::   ClientXMPP  »