ditto/live.ditto/Ditto

Ditto

class Ditto @JvmOverloads constructor(dependencies: DittoDependencies, identity: DittoIdentity = DittoIdentity.OfflinePlayground(dependencies)) : 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

constructor(dependencies: DittoDependencies, identity: DittoIdentity = DittoIdentity.OfflinePlayground(dependencies))

Creates a Ditto instance.

Types

Companion

object Companion

Properties

activated

var activated: Boolean

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

appId

var appId: String?

The App ID component of the identity in use.

auth

@JvmField

var auth: DittoAuthenticator?

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

callback

@JvmField

var callback: DittoCallback?

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.

diskUsage

@JvmField

val diskUsage: DiskUsage

Provides access to the SDK's disk usage monitoring.

isSyncActive

var isSyncActive: Boolean

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

persistenceDirectory

val persistenceDirectory: String

Path to the persistence directory in use.

presence

val presence: Presence

3rd version of presence. Use getPresence() to call from Java.

sdkVersion

val sdkVersion: String

Returns a string identifying version metadata of the Ditto SDK. Example: And4.4.3_73d36

siteId

@JvmField

val siteId: BigInteger

The site identifier component of the identity in use.

smallPeerInfo

@JvmField

val smallPeerInfo: DittoSmallPeerInfo

Provides access to the SDK's small peer info functionality.

store

@JvmField

val store: DittoStore

Provides access to store related functionality.

sync

@JvmField

val sync: DittoSync

Provides access to sync related functionality.

transportConfig

var transportConfig: DittoTransportConfig

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

Functions

open override fun close()

Shut down Ditto and release all resources. Must be called before recreating a Ditto instance that uses the same persistence directory.

disableSyncWithV3

fun disableSyncWithV3()

Explicitly opt-in to disabling the ability to sync with Ditto peers running any version of the SDK in the v3 (or lower) series of releases.

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: DittoPeersObserverV1Callback): 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.

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

open fun startSync()

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

stopSync

open fun stopSync()

Stops all network transports.