ditto/live.ditto/DittoIdentity/SharedKey

SharedKey

class ~~SharedKey~~ @JvmOverloads constructor(val dependencies: DittoDependencies, val appId: String, val sharedKey: String, val siteId: BigInteger? = null) : DittoIdentity

Deprecated

DittoIdentity.SharedKey is removed in SDK 5.0. Use DittoConfig with Ditto.open(config) or Ditto.openSync(config) instead.

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.

Phased out in 4.x — replaced by Ditto.open and Ditto.openSync factory methods. This API will be replaced by the new factory methods in v5.

Parameters

dependencies

the dependencies required by the SDK to be initialised.

appId

the name of the app. All peers must use the same app name to communicate.

sharedKey

a base64-encoded DER private key. Refer to Ditto documentation for details about generating shared keys.

siteId

the site identifier of the peer.

Constructors

SharedKey

@JvmOverloads

constructor(dependencies: DittoDependencies, appId: String, sharedKey: String, siteId: BigInteger? = null)

Properties

val appId: String

val dependencies: DittoDependencies

sharedKey

@JvmField

val sharedKey: String

siteId

@JvmField

val ~~siteId~~: BigInteger? = null

Functions

appId

fun appId(): String?

Convenience accessor for appId property value of subclasses.

requiresOfflineLicenseToken

fun requiresOfflineLicenseToken(): Boolean