kotlinphoenix-client/io.github.ajacquierbret.kotlinphoenix.client/Presence

Presence

class Presence(channel: Channel, scope: CoroutineScope, opts: Presence.Options)

Types

data class Caller(onJoin: OnJoin, onLeave: OnLeave, onSync: OnSync)

Collection of callbacks with default values

object Companion

enum Events : Enum<Presence.Events>

Presence Events of "state" and "diff"

data class Options(events: Map<Presence.Events, String>)

Custom options that can be provided when creating Presence

Functions

fun filterBy(predicate: (Map.Entry<String, PresenceMap>) -> Boolean?): PresenceState

fun list(): List<PresenceMap>

fun onJoin(callback: OnJoin)

fun onLeave(callback: OnLeave)

fun onSync(callback: OnSync)

Properties

var joinRef: String?

The channel's joinRef, set when state events occur

var pendingDiffs: MutableList<PresenceDiff>

Pending join and leave diffs that need to be synced

var state: PresenceState

The state of the Presence