Presence

class Presence(channel: Channel, opts: Presence.Options)
Content copied to clipboard

Types

Caller
Link copied to clipboard
data class Caller(onJoin: OnJoin, onLeave: OnLeave, onSync: OnSync)
Content copied to clipboard
Collection of callbacks with default values
Companion
Link copied to clipboard
object Companion
Content copied to clipboard
Events
Link copied to clipboard
enum Events : Enum<Presence.Events>
Content copied to clipboard
Presence Events of "state" and "diff"
Options
Link copied to clipboard
data class Options(events: Map<Presence.Events, String>)
Content copied to clipboard
Custom options that can be provided when creating Presence

Functions

filterBy
Link copied to clipboard
fun filterBy(predicate: (Map.Entry<String, PresenceMap>) -> Boolean?): PresenceState
Content copied to clipboard
list
Link copied to clipboard
fun list(): List<PresenceMap>
Content copied to clipboard
listBy
Link copied to clipboard
fun <T> listBy(transform: (Map.Entry<String, PresenceMap>) -> T): List<T>
Content copied to clipboard
onJoin
Link copied to clipboard
fun onJoin(callback: OnJoin)
Content copied to clipboard
onLeave
Link copied to clipboard
fun onLeave(callback: OnLeave)
Content copied to clipboard
onSync
Link copied to clipboard
fun onSync(callback: OnSync)
Content copied to clipboard

Properties

isPendingSyncState
Link copied to clipboard
val isPendingSyncState: Boolean
Content copied to clipboard
True if the Presence has not yet initially synced
joinRef
Link copied to clipboard
var joinRef: String?
Content copied to clipboard
The channel's joinRef, set when state events occur
pendingDiffs
Link copied to clipboard
var pendingDiffs: MutableList<PresenceDiff>
Content copied to clipboard
Pending join and leave diffs that need to be synced
state
Link copied to clipboard
var state: PresenceState
Content copied to clipboard
The state of the Presence