Presence

The entrypoint for all actions that relate presence of other peers known by the current peer, either directly or through other peers.

You don't create one directly but can access it from a particular Ditto instance via its presence property.

Types

Companion

object Companion

Properties

connectionRequestHandler

var connectionRequestHandler: DittoConnectionRequestHandler?

Set this handler to control which peers in a Ditto mesh can connect to the current peer.

connectionRequestHandlerJava

@get:JvmName(name = "getConnectionRequestHandler")

@set:JvmName(name = "setConnectionRequestHandler")

var connectionRequestHandlerJava: DittoConnectionRequestHandlerCallback?

Set this handler to control which peers in a Ditto mesh can connect to the current peer. Exposed to Java as getConnectionRequestHandler and setConnectionRequestHandler.

graph

val graph: DittoPresenceGraph

The latest snapshot of information about peers in the Ditto mesh network.

peerMetadata

var peerMetadata: Map<String, Any?>

Metadata associated with the current peer.

peerMetadataJsonString

var peerMetadataJsonString: String

Metadata associated with the current peer.

Functions

open override fun close()

Stops callbacks from presence graph updates.

finalize

fun finalize()

Close before garbage collection.

observe

fun observe(handler: (DittoPresenceGraph) -> Unit): DittoPresenceObserver

fun observe(callback: DittoPresenceObserverCallback): DittoPresenceObserver

Request information about Ditto peers in the local peer-to-peer network. The V3 observer differs from observePeersV2 by delivering strongly typed objects with documentation in addition to an easy way to get a JSON representation of the presence object graph.