Event Object

Events

Events allow the client to stay up to date with changes to the chat. Examples are a new message, a user’s image that updated, a reaction, or a member joining the channel. There are a 4 different type of events. These first 2 types of events you receive if you’re connected to Stream, no further action is needed to receive these events:

• Client events : You always receive these events. Examples are connection.recovered, health.check and connection.changed

• Notification events: Notification events notify you when something changed on a channel you are a member of even if you’re not explicitly watching that channel. One example is someone starting a new channel to message you while you are currently in the app. All notification event type start with notification

The last 2 groups of events require you to subscribe to them

• User presence events : queryUsers, queryChannels and channel.watch() allow you to specify presence=True, if you specify this option you’ll opt in to receiving updates about the users on these channels. You’ll receive events when they go online/offline or their data is updated

• Channel events : if you call queryChannels with watch=true, or you call channel.watch() you’ll opt-in to receiving events for the given channels. Examples are new messages, people joining the chat etc.

A full list of events is shown below. The next section of the documentation explains how to listen for events.

Event Object