initialize

⚙️ initialize() Method

The initialize method is the first and most critical step in setting up the Ditto ID SDK. It establishes a secure session and begins the onboarding or authentication workflow. This method is asynchronous and its progress is tracked via events.

🎯 Purpose

• Bootstraps the Ditto ID SDK.
• Creates a Ditto ID session in the PRIMARY state.
• Prepares the SDK for secure communication and identity workflows (e.g., onboarding, login).

🚀 Key Characteristics

• Asynchronous: It does not return a direct response. Progress is reported via SDK events.
• Event-driven: You must register event listeners before or at the time of calling initialize() to capture lifecycle events.
• Platform-specific setup: Parameters and listener methods vary slightly across platforms.

📡 Key Events Triggered by initialize()

🚀 RDNA Client Initialization (All Frameworks)

Ditto ID SDK must be initialized before using any of its features. Below are platform-specific initialization methods and parameter explanations.

RdClient.initialize(
  currentAgentInfo,
  currentGatewayHost,
  currentGatewayPort,
  cipherSpecs,
  cipherSalt,
  jsonProxySettings,
  sslDetails,
RDNALoggingLevel.RDNA_NO_LOGS,
 InitOptions,
  (syncResponse) => {
    console.log(syncResponse);
  }
);

rdnaClient.initialize(
  AGENT_INFO,
  HOST,
  PORT,
  CIPHERSPECS,
  CIPHER_SALT,
  PROXY_SETTINGS,
  RDNASSLCertificate,
  RDNALoggingLevel.RDNA_NO_LOGS,
  InitOptions: String?,
);

com.uniken.rdnaplugin.RdnaClient.initialize(
  initSuccess,
  initFailure,
  [
    AGENT_INFO,
    HOST,
    PORT,
    CIPHERSPECS,
    CIPHER_SALT,
    PROXY_SETTINGS,
    RDNASSLCertificate,
		com.uniken.rdnaplugin.RdnaClient.RDNALoggingLevel.RDNA_NO_LOGS,
  		InitOptions
  ]
);

-(RDNAError *)initialize:(NSString *)agentInfo
               Callbacks:(id<SomeCallbackProtocol>)callbacks
            GatewayHost:(NSString *)authGatewayHNIP
            GatewayPort:(uint16_t)authGatewayPORT
             CipherSpec:(NSString *)cipherSpec
             CipherSalt:(NSString *)cipherSalt
         ProxySettings:(RDNAProxySettings *_Nullable)proxySettings
  RDNASSLCertificate:(RDNASSLCertificate *_Nullable)rdnaSSLCertificate
        DNSServerList:(NSArray<NSString*> *_Nullable)dnsServerList
        RDNALoggingLevel:(RDNALoggingLevel)loggingLevel
             InitOptions:(NSString *)InitOptions
           AppContext:(id)appCtx;

RDNA.RDNAError Initialize(
  String agentInfo,
  RDNACallbacks rdnaCallbacks,
  String authGatewayHNIP,
  int authGatewayPORT,
  String cipherSpecs,
  String cipherSalt,
  RDNAProxySettings proxySettings,
  RDNASSLCertificate sslCertificate,
  String[] dnsServer,
RDNALoggingLevel loggingLevel,
 String InitOptions,
  Object appCtx
);

'InitOptions' Parameter Structure

The initOptions is a JSON string that gets parsed and contains configuration for initializing the Ditto SDK. here's the structure:

Sample JSON (Default)

{
    "permissionOptions": {
      "isLocationPermissionRequired": true,
      "isLocationPermissionMandatory": false
    },
    "languageOptions": {
      "localeCode": "en_US",
      "localeName": "English",
      "languageDirection": 0  // 0 = LTR (Left-to-Right), 1 = RTL (Right-to-Left)
    },
    "otelConfig": {
      "disableTrace": 0,
      "otelTraceFlushTimeout": 5000,
      "enableEncoding": "",
      "otelHTTPEndpointURL": ""
    }
  }

Key Details

Sample Code

const InitOptions = JSON.stringify({
    permissionOptions: {
      isLocationPermissionRequired: true,
      isLocationPermissionMandatory: false
    },
    languageOptions: {
      localeCode: "en_US",
      localeName: "English",
      languageDirection: 0  // LTR
    },
    otelConfig: {
      disableTrace: 0,
      otelTraceFlushTimeout: 5000,
      enableEncoding: "",
      otelHTTPEndpointURL: ""
    }
  });

📘 SDK Error Codes and Handling for Initialization

This section documents specific error codes that may occur during the Initialize API call and the recommended developer action.

🔹 Error Code: 88

• Enum: RDNA_ERR_RDNA_ALREADY_INITIALIZED
• Event/API: Initialize(Sync)
• Action: Terminate the SDK to avoid re-initialization. This helps during development and prevents errors during React Native code refresh.

🔹 Error Code: 179

• Enum: RDNA_ERR_INITIALIZE_ALREADY_IN_PROGRESS
• Event/API: Initialize(Sync)
• Action: Avoid invoking the Initialize API again while initialization is already in progress. Wait for the current initialization to complete.

🔹 Error Code: 218

• Enum: RDNA_ERR_DEVICE_SECURITY_CHECKS_FAILED_FRIDA_MODULES_DETECTED
• Event/API: Initialize(Sync)
• Action: The SDK detected a Frida attack. This is triggered when:
  • Connection profile has MTD enabled, and
  • “Device Threat” category has “App Tampering” detection set to Terminate or Report.