Ditto

class Ditto @JvmOverloads() constructor(dependencies: DittoDependencies, identity: DittoIdentity)

Ditto is the entry point for accessing Ditto-related functionality.

Parameters

dependencies

the dependencies required by the SDK to be initialised.

identity

the identity to be used to represent the connected client.

Constructors

Ditto

@JvmOverloads()

fun Ditto(dependencies: DittoDependencies, identity: DittoIdentity = DittoIdentity.OfflinePlayground(dependencies))

Creates a Ditto instance.

Types

Companion

object Companion

Functions

getStore

fun getStore(): DittoStore

Provides access to the SDK's store functionality.

getTransportDiagnostics

fun getTransportDiagnostics(): DittoTransportDiagnostics

Request bulk status information about the transports.

observePeers

fun observePeers(handler: (List<DittoRemotePeer>) -> Unit): DittoPeersObserver

Request information about Ditto peers connected to this device.

fun observePeers(callback: DittoPeersObserverCallback): DittoPeersObserver

Request information about Ditto peers connected to this device.

observePeersV2

fun observePeersV2(handler: (String) -> Unit): DittoPeersObserver

Request information about Ditto peers in the local peer-to-peer network.

fun observePeersV2(callback: DittoPeersObserverV2Callback): DittoPeersObserver

Request information about Ditto peers in the local peer-to-peer network.

refreshPermissions

fun refreshPermissions()

Provide a hint to Ditto that app permissions may have changed.

runGarbageCollection

fun runGarbageCollection()

Removes all sync metadata for any remote peers which aren't currently connected.

setAccessLicense

fun setAccessLicense(licenseToken: String)

Activate a Ditto instance by setting a license token.

setLicenseToken

fun setLicenseToken(licenseToken: String)

Activate a Ditto instance by setting a license token.

setTransportConfig

fun setTransportConfig(config: DittoTransportConfig)

Assign a new transports configuration.

startSync

fun startSync()

Starts the network transports.

stopSync

fun stopSync()

Stops all network transports.

tryStartSync

fun tryStartSync()

Starts the network transports.

Properties

activated

var activated: Boolean = false

A flag indicating whether or not the SDK has been activated with a valid license token.

auth

@JvmField()

var auth: DittoAuthenticator? = null

Provides access to authentication information and methods for logging on to Ditto Cloud.

callback

@JvmField()

var callback: DittoCallback? = null

An optional callback that will be called with lifecycle events relating to the SDK.

isSyncActive

var isSyncActive: Boolean = false

A flag indicating whether or not sync is active.

sdkVersion

val sdkVersion: String

Returns a string identifying the version of the Ditto SDK.

siteID

@JvmField()

val siteID: BigInteger

The site ID component of the identity in use.

store

@JvmField()

val store: DittoStore

Provides access to the SDK's store functionality.