Event Index¶

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

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

• Data:

• Source:

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.

killed

• Data:

• Source:

last_activity

• Data:

• Source:

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_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

• Data:

• Source:

muc::[room]::got_online

• Data:

• Source:

muc::[room]::message

• Data:

• Source:

muc::[room]::presence

• Data:

• Source:

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.

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 future implementation of XEP-0198: Stream Management will distinguish 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.

socket_error

• Data: Socket exception object

• Source: XMLstream

stream_error

• Data: StreamError

• Source: BaseXMPP