Initialize the SDK

To initialize the SDK, you need to provide an SdkConfig with your desired configuration.

SDK config builder

The minimum viable SdkConfig is SdkConfig.Builder().build(), although the following configurations are also available:

Configuration	Method	Default
API environment	setApiEnvironment	Production
Cloud auth token	setCloudAuthToken	-
Cloud refresh token	setCloudRefreshToken	-
Fusion host	setFusionHost	http://localhost:27700
Secure storage	setSecureStorageOverride	-
Debug Logging	setDebugLogging	false

info

If you initialize the SDK without a cloud auth token, you will need to either provide one manually through the context manager or call the login function to access most SDK functionalities.

Secure storage

By default, the SDK stores the context information on its own, as shown in the following table:

Platform	Storage
Android	EncryptedSharedPreferences
JVM	Memory
iOS / macOS / watchOS	Keychain
JS / Node	LocalStorage
C# / Python	Memory

info

To override the default secure storage, you must implement the SecureStorage interface and pass the class through the setSecureStorageOverride function from SdkConfig builder.

Initialize

Kotlin

val sdkConfig = SdkConfig.Builder()
  .setCloudAuthToken("AUTH_TOKEN")
  .build()
val sdk = KDoordeckFactory.initialize(sdkConfig)

Java

var sdkConfig = SdkConfig.Builder()
  .setCloudAuthToken("AUTH_TOKEN")
  .build(); 
var sdk = KDoordeckFactory.INSTANCE.initializeAsync(sdkConfig);

Swift

let sdkConfig = SdkConfig.Builder()
  .setCloudAuthToken(cloudAuthToken: "AUTH_TOKEN")
  .build()
let sdk = await KDoordeckFactory().initialize(sdkConfig: sdkConfig)

JavaScript

import { com } from "@doordeck/doordeck-headless-sdk";

const sdk = await com.doordeck.multiplatform.sdk.KDoordeckFactory.initialize(
  new com.doordeck.multiplatform.sdk.config.SdkConfig.Builder()
    .setCloudAuthToken("AUTH_TOKEN")
    .build(),
);

C#

var sdk = new DoordeckSdk(cloudAuthToken: "AUTH_TOKEN");

info

You should also call sdk.Release(); at the end of your application’s lifecycle to release the SDK resources.

Python

sdk = doordeck_headless_sdk.InitializeSdk(cloud_auth_token="AUTH_TOKEN")