ditto/live.ditto/Ditto

Ditto

class Ditto : DittoBase

Entrypoint for accessing Ditto-related functionality in the Kotlin SDK.

Constructors

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

Public constructor using legacy dependency injection pattern.

Types

object Companion

Properties

absolutePersistenceDirectory

val absolutePersistenceDirectory: String

The absolute path to the persistence directory used by this Ditto instance to persist data.

val activated: Boolean

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

var appId: String?

The App ID component of the identity in use.

var auth: DittoAuthenticator?

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

var callback: DittoCallback?

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

val config: DittoConfig

Returns the configuration used to initialize this Ditto instance.

var deviceName: String

Configure a custom identifier for this peer.

val diskUsage: DiskUsage

Provides access to the SDK's disk usage monitoring.

val 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.

val presence: Presence

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

val sdkVersion: String

A string of version metadata for the Ditto SDK. Example: And4.4.3_73d36

val ~~siteId~~: BigInteger

The site identifier component of the identity in use.

val smallPeerInfo: DittoSmallPeerInfo

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

val store: DittoStore

Provides access to store related functionality.

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()

Disable sync with peers running version 3 or lower of the Ditto SDK.

getTransportDiagnostics

fun getTransportDiagnostics(): DittoTransportDiagnostics

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

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

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

Request information about Ditto peers connected to this device.

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.

open fun startSync()

Starts the network transports. Ditto will connect to other devices.

open fun stopSync()

Stops all network transports.

updateAppBackgroundForeground

fun updateAppBackgroundForeground(appInForeground: Boolean)

updateTransportConfig

fun updateTransportConfig(configure: (config: DittoTransportConfig) -> Unit)

Convenience method to update the current transport config of the receiver.