Add presence listener callback that gets invoked with presence events whenever a user updates an attributes, joins, leaves or timeouts a channel

2.41.0

function onPresenceListener({event, message}){
  // custom logic
}
addPresenceListener({ channel: "<your channel identifier>" }, onPresenceListener)

Get list of users present in a given channel.

2.41.0

getPresenceChannelUsers({
  channel: "<your channel identifier>",
}).then(res => console.log(res))

Get user attributes for a given user in a channel.

2.41.0

getPresenceUserAttributes().then(attributes => console.log(attributes))

Get list of channels in which a given user is present.

2.41.0

getPresenceUserChannels({
  userProfileId: "<user profile id>"
}).then(res => console.log(res))

Join a presence channel.

2.41.0

joinPresenceChannel({
  channel: "<your channel identifier>",
}).then(res => console.log(res))

Leave a presence channel.

2.41.0

leavePresenceChannel({
  channel: "<your channel identifier>",
}).then(res => console.log(res))

Remove an added presence listener callback

2.41.0

function onPresenceListener({event, message}){
  // custom logic
}
removePresenceListener({ channel: "<your channel identifier>" }, onPresenceListener)

Set user presence attributes for current user profile in a given channel.

2.41.0

setPresenceUserAttributes({
  channel: "<your channel identifier>",
  attributes: { mood: "Happy", location: "Vacation" }
}).then(attributes => console.log(attributes))