DittoIdentity

sealed class DittoIdentity

The various identity configurations that you can use when initializing a Ditto instance.

  • Development: (Deprecated - use OfflinePlayground instead) Develop peer-to-peer apps with no cloud connection. This mode offers no security and must only be used for development.

  • OfflinePlayground: Develop peer-to-peer apps with no cloud connection. This mode offers no security and must only be used for development.

  • Online: (Deprecated - use OnlineWithAuthentication instead) Run Ditto in secure production mode, logging on to Ditto Cloud or on on-premises authentication server. User permissions are centrally managed.

  • OnlineWithAuthentication: Run Ditto in secure production mode, logging on to Ditto Cloud or on on-premises authentication server. User permissions are centrally managed.

  • OnlinePlayground: Test a Ditto Cloud app without authentication ("Playground mode"). This mode offers no security and must only be used for development.

  • SharedKey: A mode where any device is trusted provided they know the secret key. This is a simplistic authentication model normally only suitable for private apps where users and devices are both trusted.

  • Manual: A manually-provided certificate identity. This accepts a base64-encoded bundle.

Types

Development
Link copied to clipboard
class Development @JvmOverloads constructor(dependencies: DittoDependencies, appID: String?, siteID: BigInteger?) : DittoIdentity

Deprecated - use OfflinePlayground instead.

Manual
Link copied to clipboard
class Manual(certificateConfig: String) : DittoIdentity

A manually-provided certificate identity. This accepts a base64-encoded bundle.

OfflinePlayground
Link copied to clipboard
class OfflinePlayground @JvmOverloads constructor(dependencies: DittoDependencies, appID: String?, siteID: BigInteger?) : DittoIdentity

Develop peer-to-peer apps with no cloud connection. This mode offers no security and must only be used for development. In this mode, any string can be used as the name of the app.

Online
Link copied to clipboard
class Online @JvmOverloads constructor(dependencies: DittoDependencies, appID: String, callback: DittoAuthenticationCallback, enableDittoCloudSync: Boolean, customAuthUrl: String?) : DittoIdentity

Deprecated - use OnlineWithAuthentication instead.

OnlinePlayground
Link copied to clipboard
class OnlinePlayground @JvmOverloads constructor(dependencies: DittoDependencies, appID: String, enableDittoCloudSync: Boolean) : DittoIdentity

Test a Ditto Cloud app without authentication ("Playground mode"). This mode offers no security and must only be used for development.

OnlineWithAuthentication
Link copied to clipboard
class OnlineWithAuthentication @JvmOverloads constructor(dependencies: DittoDependencies, appID: String, callback: DittoAuthenticationCallback, enableDittoCloudSync: Boolean, customAuthUrl: String?) : DittoIdentity

Run Ditto in secure production mode, logging on to Ditto Cloud or on on-premises authentication server. User permissions are centrally managed. Sync will not work until a successful login has occurred.

SharedKey
Link copied to clipboard
class SharedKey @JvmOverloads constructor(dependencies: DittoDependencies, appID: String, sharedKey: String, siteID: BigInteger?) : DittoIdentity

A mode where any device is trusted provided they know the secret key. This is a simplistic authentication model normally only suitable for private apps where users and devices are both trusted. In this mode, any string may be used as the app id.

Functions

close
Link copied to clipboard
fun close()
requiresOfflineLicenseToken
Link copied to clipboard
fun requiresOfflineLicenseToken(): Boolean

Inheritors

DittoIdentity
Link copied to clipboard
DittoIdentity
Link copied to clipboard
DittoIdentity
Link copied to clipboard
DittoIdentity
Link copied to clipboard
DittoIdentity
Link copied to clipboard
DittoIdentity
Link copied to clipboard
DittoIdentity
Link copied to clipboard