Class PresenceChangeEvent
- java.lang.Object
-
- com.slack.api.model.event.PresenceChangeEvent
-
- All Implemented Interfaces:
Event
,Serializable
public class PresenceChangeEvent extends Object implements Event
The presence_change event is sent to connections for a workspace when a user changes presence status and the app has subscribed using presence_sub. Clients can use this to update their local list of users' presence.If a user updates their presence manually, the manual_presence_change event will also be sent to all connected clients for that user.
There are two forms of this event. When only one user's presence is being communicated, you'll receive a user field with a single user ID present within. This form is deprecated.
Pass the batch_presence_aware=1 parameter to rtm.start or rtm.connect to instruct the Slack message server to batch your presence messages and send a users attribute instead, containing an array of users changing to the same status.
Sometimes you'll get a single event for a single user but if you use batch_presence_aware=1, that single user event will be single item in the users array.
In case you missed that: if you send batch_presence_aware=1 then the shape of presence_change events changes. Instead of a string-based user field, you'll get users, an array.
If you're writing a library that supports presence_change events, you should be prepared to handle both kinds of presence events.
RTM API Presence is now only available via subscription. As of January 2018, presence_change events are not dispatched without presence subscriptions established with presence_sub. Relatedly, current user presence status is no longer communicated in rtm.start. Learn more.
- See Also:
- Serialized Form
-
-
Constructor Summary
Constructors Constructor Description PresenceChangeEvent()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected boolean
canEqual(Object other)
boolean
equals(Object o)
String
getPresence()
String
getType()
String
getUser()
List<String>
getUsers()
int
hashCode()
void
setPresence(String presence)
void
setUser(String user)
void
setUsers(List<String> users)
String
toString()
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface com.slack.api.model.event.Event
getSubtype
-
-
-
-
Field Detail
-
TYPE_NAME
public static final String TYPE_NAME
- See Also:
- Constant Field Values
-
-