ditto/live.ditto/DittoIdentity/OnlineWithAuthentication

OnlineWithAuthentication

class OnlineWithAuthentication @JvmOverloads constructor(val dependencies: DittoDependencies, val appId: String, val callback: DittoAuthenticationCallback, val enableDittoCloudSync: Boolean = true, val customAuthUrl: String? = null) : 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.

The only required configuration is the application's UUID, which can be found on the Ditto portal where the app is registered.

By default cloud sync is enabled. This means the SDK will sync to a Big Peer in Ditto's cloud when an internet connection is available. This is controlled by the enableDittoCloudSync parameter. If true (default), a suitable wss:// URL will be added to the TransportConfig. To prevent cloud sync, or to specify your own URL later, pass false.

Authentication requests are handled by Ditto's cloud by default, configured in the portal at https://portal.ditto.live.

To use a different or on-premises authentication service, pass a custom HTTPS base URL as the customAuthUrl parameter.

Parameters

dependencies

the dependencies required by the SDK to be initialised.

appId

a UUID identifying this app registration on the Ditto portal, which can be found at https://portal.ditto.live.

callback

a handler for when Ditto requires (re)authentication.

enableDittoCloudSync

if true, auto-configure sync with Ditto Cloud.

customAuthUrl

if specified, use a custom authentication service Cloud.

Constructors

OnlineWithAuthentication

@JvmOverloads

constructor(dependencies: DittoDependencies, appId: String, callback: DittoAuthenticationCallback, enableDittoCloudSync: Boolean = true, customAuthUrl: String? = null)