Ditto

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

Ditto is the entry point for accessing Ditto-related functionality in the Android SDK.

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

allDisabledTransportsConfig

open override fun allDisabledTransportsConfig(): DittoTransportConfig

Creates a default Android transport config which has all transports disabled.

getTransportDiagnostics

fun getTransportDiagnostics(): DittoTransportDiagnostics

Request bulk status information about the transports. This is mostly intended for statistical or debugging purposes.

observePeers

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

~~fun~~ ~~observePeers~~(~~callback~~: DittoPeersObserverCallback): DittoPeersObserver

Request information about Ditto peers connected to this device.

observePeersV2

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

fun observePeersV2(callback: DittoPeersObserverV2Callback): DittoPeersObserver

Request information about Ditto peers in the local peer-to-peer network. The V2 observer differs from observePeers by providing not just information about the immediate peers, but also multihop information from other peers not immediately connected. V2 presence therefore offers a more complete view of 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. This method shouldn't usually be called. Manually running garbage collection often will result in slower sync times. Ditto automatically runs a garbage a collection process in the background at optimal times.

setAccessLicense

~~fun~~ ~~setAccessLicense~~(~~licenseToken~~: String)

Activate a Ditto instance by setting a license token. You cannot sync with Ditto before you have activated it.

setLicenseToken

~~fun~~ ~~setLicenseToken~~(~~licenseToken~~: String)

Activate a Ditto instance by setting a license token. You cannot sync with Ditto before you have activated it.

setOfflineOnlyLicenseToken

fun setOfflineOnlyLicenseToken(licenseToken: String)

Activate an offline Ditto instance by setting a license token. You cannot sync with Ditto before you have activated it. The offline license token is only valid for manual, offlinePlayground, and sharedKey identities.

startSync

~~fun~~ ~~startSync~~()

Starts the network transports. Ditto will connect to other devices and sync with them where appropriate.

stopSync

open override fun stopSync()

Stops all network transports.

tryStartSync

open fun tryStartSync()

Starts the network transports. Ditto will connect to other devices and sync with them where appropriate.

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.

deviceName

@JvmField

var deviceName: String

Configure a custom identifier for the current device.

isSyncActive

var isSyncActive: Boolean = false

A flag indicating whether or not sync is active. Use tryStartSync() to active and stopSync() to deactivate sync.

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.

transportConfig

var transportConfig: DittoTransportConfig

Assign a new transports configuration. By default peer-to-peer transports (Bluetooth and WiFi) are enabled.