Skip to main content

Dizme SDK Android Archive Library

DizmeSDK Android Archive Library

Introduction

Scope and field of document application

This document describes integration specifications and API Description of Dizme SDK library for the Android version. Within the document, the library will be called simply library, Dizme SDK, SDK, Dizme Wallet SDK or Dizme.

SDK Version

The Android library version is: 0.0.60

Release Note

  • 0.0.6: First release
  • 0.0.8: Added descriptions for the methods related to the new features:
    • reset
    • getCredentialsList
    • getNotificationsList
    • performActionFromURL
  • 0.0.9: Added descriptions for the methods related to the new features:
    • setAcceptedSchemes
    • setAcceptedCredentialDefinitions
  • 0.0.10:
    • Added more informations related to the Notify and the issued credentials
    • Added NotificationType Enum
  • 0.0.11:
    • New Android library version released
  • 0.0.12:
    • Removed Floating Action Button from the Home page of the SDK
  • 0.0.13: Added descriptions for the methods related to the new feature:
    • setNotDeletableSchemes

Integration of Dizme SDK into an Android Application

Prerequisites

Dizme SDK is provided through JFrog InfoCert Artifactory.

Prepare global gradle.properties file

To integrate Dizme as an AAR into an Android Application make sure that the necessary info are present into the gradle.properties file.

Is strongly recommended to keep this sensitive data in the file ~/.gradle/gradle.properties and not in the gradle.properties file of the Android project.

Then, within the ~/.gradle/gradle.properties file must be present these lines:

artifactory_context_url=https://infocert.jfrog.io/artifactory/
artifactory_user=JFROG_ARTIFACTORY_USERNAME
artifactory_password=JFROG_ARTIFACTORY_PASSWORD

Prepare build.gradle (Project) file

Within the build.gradle (Project) file the following elements must be added:

  • Within the buildscript's repositories block must be added following repositories:
google()
jcenter()
mavenCentral()
maven {
    url "https://storage.googleapis.com/download.flutter.io"
}
maven {url 'https://developer.huawei.com/repo/'}
maven {
	url "${artifactory_context_url}/list/dizme-native-android/"
	credentials {
		username = "${artifactory_user}"
		password = "${artifactory_password}"
	}
}
  • Add an allprojects block with the following repositories:
allprojects {
    repositories {
        google()
        jcenter()
        mavenCentral()
        maven {
            url "https://storage.googleapis.com/download.flutter.io"
        }
        maven {url 'https://developer.huawei.com/repo/'}
        maven {
			url "${artifactory_context_url}/list/dizme-native-android/"
			credentials {
				username = "${artifactory_user}"
				password = "${artifactory_password}"
		  	}
		  }
}

Below, an example of the build.gradle (project) file:

buildscript {
    repositories {
        google()
        jcenter()
        mavenCentral()
        maven {
            url "https://storage.googleapis.com/download.flutter.io"
        }
        maven {url 'https://developer.huawei.com/repo/'}
        maven {
            url "${artifactory_context_url}/list/dizme-native-android/"
            credentials {
                username = "${artifactory_user}"
                password = "${artifactory_password}"
            }
        }
    }
    dependencies {
        classpath "com.android.tools.build:gradle:7.3.1"
    }
}

allprojects {
    repositories {
        google()
        jcenter()
        mavenCentral()
        maven {
            url "https://storage.googleapis.com/download.flutter.io"
        }
        maven {url 'https://developer.huawei.com/repo/'}
        maven {
            url "${artifactory_context_url}/list/dizme-native-android/"
            credentials {
                username = "${artifactory_user}"
                password = "${artifactory_password}"
            }
        }
    }
}

task clean(type: Delete) {
    delete rootProject.buildDir
}

Prepare build.gradle (Module: app) file

Within the build.gradle (Module: app) file the following elements must be added:

  • Within the dependencies block add the following dependency:
    implementation 'it.etuitus.dizme_sdk:dizme_sdk_aar:0.0.60'

Below, an example of the build.gradle (Module: app) file:

plugins {
    id 'com.android.application'
}

android {
    compileSdk 32

    defaultConfig {
        applicationId "it.etuitus.dizmesdkdemo"
        minSdk 24
        targetSdk 32
        versionCode 1
        versionName "1.0.15"

        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
    }

    buildTypes {
        release {
            minifyEnabled false
            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
        }
    }
    compileOptions {
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }
}

dependencies {
    implementation 'androidx.appcompat:appcompat:1.4.2'
    implementation 'com.google.android.material:material:1.6.1'
    implementation 'it.etuitus.dizme_sdk:dizme_sdk_aar:0.0.60'
}

API Description and I/O Objects

DizmeSDK

The object through which it is possible to perform all the main features offered by the SDK is the object it.etuitus.dizme_sdk_aar.DizmeSDK. Each method invoked will provide the result through a specific callback. To receive the latter, it is necessary to implement the relevant interfaces: it.etuitus.dizme_sdk_aar.interfaces.DizmeSDKCallback and it.etuitus.dizme_sdk_aar.interfaces.DizmeSDKInitCallback interfaces.

Object initialization

The constructor of the DizmeSDK object takes a mandatory parameter (if not provided, an Exception will be thrown):

  • An object of type android.content.Context

API Description

Below the description of the DizmeSDK object methods:

  • createWallet(String walletPassword, DizmeSDKEnvironment dizmeSDKEnvironment, DizmeSDKLanguage dizmeSDKLanguage, String pushToken, String domainInvitation, String domain, DizmeSDKInitCallback callbackFunction): This method is useful to perform the first initialization of the SDK. So it will only be called once. Below the description of the parameters:

    • java.lang.String walletPassword: A String that represents the Dizme SDK Wallet Password.
    • it.etuitus.dizme_sdk_aar.models.DizmeSDKEnvironment dizmeSDKEnvironment: The Dizme SDK Wallet environment
    • it.etuitus.dizme_sdk_aar.models.DizmeSDKLanguage dizmeSDKLanguage: An Enum that represents the language to set for the Dizme SDK Wallet.
    • java.lang.String pushToken: A String that represents the push notifications related token.
    • java.lang.String domainInvitation: A String that represents the invitation URL for the connection with the Domain.
    • java.lang.String domain: A String that represents the Domain name.
    • it.etuitus.dizme_sdk_aar.interfaces.DizmeSDKInitCallback callbackFunction: The callback that will be called at the end of the createWallet operation. Will be called the 'DizmeSDKInitCallback.onCreateWalletCompleted' callback.

  • openWallet(String walletPassword, String pushToken, DizmeSDKInitCallback callbackFunction): This method is useful to perform the initialization of the SDK at each startup of the Integrant Application. Below the description of the parameters:

    • java.lang.String walletPassword: A String that represents the Dizme SDK Wallet Password.
    • java.lang.String pushToken: A String that represents the push notifications related token.
    • it.etuitus.dizme_sdk_aar.interfaces.DizmeSDKInitCallback callbackFunction: The callback that will be called at the end of the openWallet operation. Will be called the 'DizmeSDKInitCallback.onOpenWalletCompleted' callback.

  • initializeSDKFromBackup(String backupFilePath, String walletPassphrase, String walletPassword, DizmeSDKLanguage dizmeSDKLanguage, String pushToken, String domain, DizmeSDKInitCallback callbackFunction): This method is useful to perform the initialization of the SDK using a backup file. Below the description of the parameters:

    • java.lang.String backupFilePath: A String that represents the path of the Dizme SDK Wallet backup file.
    • java.lang.String walletPassphrase: A String that represents the Dizme SDK Wallet Passphrase necessary to execute the recovery of the Dizme Wallet.
    • java.lang.String walletPassword: A String that represents the Dizme SDK Wallet Password.
    • it.etuitus.dizme_sdk_aar.models.DizmeSDKLanguage dizmeSDKLanguage: An Enum that represents the language to set for the Dizme SDK Wallet.
    • java.lang.String pushToken: A String that represents the push notifications related token.
    • java.lang.String domain: A String that represents the Domain name.
    • it.etuitus.dizme_sdk_aar.interfaces.DizmeSDKInitCallback callbackFunction: The callback that will be called at the end of the initializeSDKFromBackup operation. Will be called the 'DizmeSDKInitCallback.onInitializeSDKFromBackup' callback.

The methods described above may also be called as DizmeSDK init methods or init methods. The operations that the SDK will perform by invoking them will be defined as init operations

  • startDizme(DizmeSDKInitCallback callbackFunction, @Nullable String dataFromIntent): This method is useful to start the main view of the Dizme SDK. Below the description of the parameters:

    • it.etuitus.dizme_sdk_aar.interfaces.DizmeSDKInitCallback callbackFunction: The callback that will be called at the end of the startDizme operation. Will be called the 'DizmeSDKInitCallback.onStartCompleted' callback
    • java.lang.String dataFromIntent: A String that represents the URI (as String) received by the Integrant App, if it is intended for Dizme.

  • analyzeNotify(DizmeSDKCallback callbackFunction, Map<String, Object> notifyMessageAsMap): This method is useful to analyze Integrating App's incoming notifications. If the incoming messages belong to Dizme the output of this method will be true, otherwise false. In the first case, DizmeSDK will execute (on background) the related operations, dependent from the received message. Below the description of the parameters:

    • it.etuitus.dizme_sdk_aar.interfaces.DizmeSDKCallback callbackFunction: The callback that will be called at the end of the analyzeNotify operation. Will be called the 'DizmeSDKCallback.onAnalyzeNotifyCompleted' callback
    • java.utils.Map notifyMessageAsMap: A notify message, as Map, received by the Integrating Application.

  • doBackup(DizmeSDKCallback callbackFunction): This method is useful to ask Dizme SDK to execute the backup of the entire Wallet. Below the description of the parameters:

    • it.etuitus.dizme_sdk_aar.interfaces.DizmeSDKCallback callbackFunction: The callback that will be called at the end of the doBackup operation. Will be called the 'DizmeSDKCallback.onDoBackupCompleted' callback

  • getWalletPassphrase(DizmeSDKCallback callbackFunction): This method is useful to obtain the Dizme SDK Wallet Passphrase useful to execute the Dizme Wallet Recovery (initializeSDKFromBackup). Below the description of the parameters:

    • it.etuitus.dizme_sdk_aar.interfaces.DizmeSDKCallback callbackFunction: The callback that will be called at the end of the getWalletPassphrase operation. Will be called the 'DizmeSDKCallback.onGetWalletPassphraseCompleted' callback

  • getEnvironment(DizmeSDKCallback callbackFunction): This method is useful to obtain the Dizme SDK Wallet Environment. Below the description of the parameters:

    • it.etuitus.dizme_sdk_aar.interfaces.DizmeSDKCallback callbackFunction: The callback that will be called at the end of the getEnvironment operation. Will be called the 'DizmeSDKCallback.onGetEnvironmentCompleted' callback

  • getSDKVersion(DizmeSDKCallback callbackFunction): This method is useful to obtain the Dizme SDK Wallet version. Below the description of the parameters:

    • it.etuitus.dizme_sdk_aar.interfaces.DizmeSDKCallback callbackFunction: The callback that will be called at the end of the getSDKVersion operation. Will be called the 'DizmeSDKCallback.onGetSDKVersionCompleted' callback

  • getStatus(DizmeSDKCallback callbackFunction): This method is useful to obtain the Dizme SDK Wallet status. Below the description of the parameters:

    • it.etuitus.dizme_sdk_aar.interfaces.DizmeSDKCallback callbackFunction: The callback that will called at the end of the getStatus operation. Will be called the 'DizmeSDKCallback.onGetStatusCompleted' callback

  • setLanguage(DizmeSDKCallback callbackFunction, DizmeSDKLanguage dizmeSDKLanguage): This method is useful to set the language of the Dizme SDK. Below the description of the parameters:

    • it.etuitus.dizme_sdk_aar.interfaces.DizmeSDKCallback callbackFunction: The callback that will be called at the end of the setLanguage operation. Will be called the 'DizmeSDKCallback.onSetLanguageCompleted' callback
    • it.etuitus.dizme_sdk_aar.interfaces.DizmeSDKLanguage dizmeSDKLanguage: The language to set

  • getLanguage(DizmeSDKCallback callbackFunction): This method is useful to obtain the language of the Dizme SDK. Below the description of the parameters:

    • it.etuitus.dizme_sdk_aar.interfaces.DizmeSDKCallback callbackFunction: The callback that will be called at the end of the getLanguage operation. Will be called the 'DizmeSDKCallback.onGetLanguageCompleted' callback

  • getMaintenanceInfo(DizmeSDKCallback callbackFunction): This method is useful to obtain info about the Maintenance.

    • it.etuitus.dizme_sdk_aar.interfaces.DizmeSDKCallback callbackFunction: The callback that will be called at the end of the getMaintenanceInfo operation. Will be called the 'DizmeSDKCallback.onGetMaintenanceInfoCompleted' callback

  • openNotify(DizmeSDKCallback callbackFunction, String notifyId): This method is useful to open a it.etuitus.dizme_sdk_aar.models.Notify object.

    • it.etuitus.dizme_sdk_aar.interfaces.DizmeSDKCallback callbackFunction: The callback that will be called at the end of the openNotify operation. Will be called the 'DizmeSDKCallback.onOpenNotifyCompleted' callback
    • java.lang.String notifyId: The unique identifier representing the it.etuitus.dizme_sdk_aar.models.Notify object chosen by the Integrant Application.

  • androidx.fragment.app.Fragment getDizmeSDKFragment(): This method is useful to obtain the Dizme SDK Fragment. Within the latter will be displayed all Views of the SDK. A androidx.fragment.app.Fragment object will be returned.

  • getMyDomainDid(DizmeSDKCallback callbackFunction): This method is useful to obtain the SDK DID related to the connection with the Domain.

    • it.etuitus.dizme_sdk_aar.interfaces.DizmeSDKCallback callbackFunction: The callback that will be called at the end of the getMyDomainDid operation. Will be called the 'DizmeSDKCallback.onGetMyDomainDidCompleted' callback

  • setNotifyCallback(DizmeSDKCallback callbackFunction): This method is useful to set the callback that will be called when a new it.etuitus.dizme_sdk_aar.models.Notify object was received by the SDK.

    • it.etuitus.dizme_sdk_aar.interfaces.DizmeSDKCallback callbackFunction: The callback that will be called when a new it.etuitus.dizme_sdk_aar.models.Notify object was received. Will be called the 'DizmeSDKCallback.onNewNotificationReceived' callback

  • reset(DizmeSDKCallback callbackFunction): This method is useful to ask Dizme SDK to reset the entire Dizme Wallet. This method must be invoked only when the DizmeSDK Fragment, obtained using the method androidx.fragment.app.Fragment getDizmeSDKFragment(), is not in foreground (not shown). This is because when the reset will be performed, the latter will be restarted. When the callback will be called it will be possible to interact with the DizmeSDKFragment again.

    • it.etuitus.dizme_sdk_aar.interfaces.DizmeSDKCallback callbackFunction: The callback that will be called at the end of the reset operation. Will be called the 'DizmeSDKCallback.onResetCompleted' callback

  • performActionFromURL(DizmeSDKCallback callbackFunction, String url): This method is useful to provide to Dizme SDK the content of a Dizme QRCode, as an URL (as a String). If the URL is valid (belong to Dizme), the SDK will execute (on background) the related operations. Below the description of the parameters:

    • it.etuitus.dizme_sdk_aar.interfaces.DizmeSDKCallback callbackFunction: The callback that will be called at the end of the performActionFromURL operation. Will be called the 'DizmeSDKCallback.onActionFromURLPerformed' callback
    • java.lang.String url: The URL, as a String, extracted from a Dizme QRCode.

  • getNotificationsList(DizmeSDKCallback callbackFunction): This method is useful to obtain the list of the incomnig notifications, as a list of it.etuitus.dizme_sdk_aar.models.Notify objects.

    • it.etuitus.dizme_sdk_aar.interfaces.DizmeSDKCallback callbackFunction: The callback that will be called at the end of the getNotificationsList operation. Will be called the 'DizmeSDKCallback.onGetNotificationsListCompleted' callback

  • getCredentialsList(DizmeSDKCallback callbackFunction): This method is useful to obtain the list of the Credentials contained within the Dizme Wallet, as a JSON String.

    • it.etuitus.dizme_sdk_aar.interfaces.DizmeSDKCallback callbackFunction: The callback that will be called at the end of the getCredentialsList operation. Will be called the 'DizmeSDKCallback.onGetCredentialsListCompleted' callback

  • setAcceptedSchemes(DizmeSDKCallback callbackFunction, List<String> schemesList): This method is useful to set a list of schemes to make the SDK accept all the credentials issued using that specific schema without requiring the user to verify the data contained within the related Credential. Therefore, by setting a Schema Id, the SDK will accept each Credential, which refers to that Schema Id, which can be issued by multiple Issuers.

    • it.etuitus.dizme_sdk_aar.interfaces.DizmeSDKCallback callbackFunction: The callback that will be called at the end of the setAcceptedSchemes operation. Will be called the 'DizmeSDKCallback.onSetAcceptedSchemesCompleted' callback
    • java.util.List<String> schemesList: The list of Schemes Identifiers (as String) to set.

  • setAcceptedCredentialDefinitions(DizmeSDKCallback callbackFunction, List<String> credentialDefinitionsList): This method is useful to set a list of Credential Definition Id to make the SDK accept all the credentials issued using that Id without requiring the user to verify the data contained within the related Credential. Therefore, by setting a Credential Definition Id, the SDK will accept each Credential with that Id which can be issued by specific Issuer.

    • it.etuitus.dizme_sdk_aar.interfaces.DizmeSDKCallback callbackFunction: The callback that will be called at the end of the setAcceptedCredentialDefinitions operation. Will be called the 'DizmeSDKCallback.onSetAcceptedCredentialDefinitionsCompleted' callback
    • java.util.List<String> credentialDefinitionsList: The list of Credential Definition Identifiers (as String) to set.

  • setNotDeletableSchemes(DizmeSDKCallback callbackFunction,List<String> schemesList): This method is useful to set a list of Schemes Identifiers to make the SDK not allow to delete the credentials having that specific schema identifier. Therefore, by setting a Schema Id, the SDK will not allow to delete Credentials which refer to that Schema Id.

    • it.etuitus.dizme_sdk_aar.interfaces.DizmeSDKCallback callbackFunction: The callback that will be called at the end of the setNotDeletableSchemes operation. Will be called the 'DizmeSDKCallback.onSetNotDeletableSchemesCompleted' callback
    • java.util.List<String> schemesList: The list of Schemes Identifiers (as String) to set.

DizmeSDKInitCallback

Below the description of the callback methods for the init operations:

  • void onCreateWalletCompleted(DizmeSDKInitResult dizmeSDKInitResult);:This callback will be invoked when the operations performed by the DizmeSDK.createWallet method are completed.
    • The it.etuitus.dizme_sdk_aar.models.DizmeSDKInitResult object contains the result of the createWallet operations.
  • void onOpenWalletCompleted(DizmeSDKInitResult dizmeSDKInitResult);:This callback will be invoked when the operations performed by the DizmeSDK.openWallet method are completed.
    • The it.etuitus.dizme_sdk_aar.models.DizmeSDKInitResult object contains the result of the openWallet operations.
  • void onInitializeSDKFromBackup(DizmeSDKInitResult dizmeSDKInitResult);:This callback will be invoked when the operations performed by the DizmeSDK.initializeSDKFromBackup method are completed.
    • The it.etuitus.dizme_sdk_aar.models.DizmeSDKInitResult object contains the result of the initializeSDKFromBackup operations.
  • void onStartCompleted(boolean startResult, @Nullable DizmeSDKInitError dizmeSDKInitError);:This callback will be invoked when the operations performed by the DizmeSDK.startDizme method are completed.
    • The boolean startResult represents the outcome of the start operation.
    • The it.etuitus.dizme_sdk_aar.errors.DizmeSDKInitError object describes the errors, if occurred, during the execution of the start operation.

DizmeSDKCallback

Below the description of the callback methods for the SDK operations:

  • void onAnalyzeNotifyCompleted(boolean analyzeResult, @Nullable DizmeSDKError dizmeSDKError);:This callback will be invoked when the operations performed by the DizmeSDK.analyzeNotify method are completed.

    • The boolean analyzeResult represents the outcome of the analyzeNotify operation.
    • The it.etuitus.dizme_sdk_aar.errors.DizmeSDKErrordizmeSDKError object describes the errors, if occurred, during the execution of the analyzeNotify operation.

  • void onDoBackupCompleted(boolean doBackupResult, @Nullable String backupFilePath, @Nullable DizmeSDKError dizmeSDKError);:This callback will be invoked when the operations performed by the DizmeSDK.doBackup method are completed.

    • The boolean doBackupResult represents the outcome of the doBackup operation.
    • The java.lang.String backupFilePath represents the path of the backup file
    • The it.etuitus.dizme_sdk_aar.errors.DizmeSDKError dizmeSDKError object describes the errors, if occurred, during the execution of the doBackup operation.

  • void onGetWalletPassphraseCompleted(@Nullable String walletPassphrase, @Nullable DizmeSDKError dizmeSDKError);:This callback will be invoked when the operations performed by the DizmeSDK.getWalletPassphrase method are completed.

    • The java.lang.String walletPassphrase represents the walletPassphrase.
    • The it.etuitus.dizme_sdk_aar.errors.DizmeSDKError dizmeSDKError object describes the errors, if occurred, during the execution of the getWalletPassphrase operation.

  • void onGetEnvironmentCompleted(DizmeSDKEnvironment environment, @Nullable DizmeSDKError dizmeSDKError);:This callback will be invoked when the operations performed by the DizmeSDK.getEnvironment method are completed.

    • The it.etuitus.dizme_sdk_aar.models.DizmeSDKEnvironment environment represents the SDK Environment.
    • The it.etuitus.dizme_sdk_aar.errors.DizmeSDKError dizmeSDKError object describes the errors, if occurred, during the execution of the getEnvironment operation.

  • void onGetSDKVersionCompleted(String sdkVersion, @Nullable DizmeSDKError dizmeSDKError);:This callback will be invoked when the operations performed by the DizmeSDK.getSDKVersion method are completed.

    • The java.lang.String sdkVersion represents the SDK version name.
    • The it.etuitus.dizme_sdk_aar.errors.DizmeSDKError dizmeSDKError object describes the errors, if occurred, during the execution of the getSDKVersion operation.

  • void onGetStatusCompleted(DizmeSDKStatus status, @Nullable DizmeSDKError dizmeSDKError);:This callback will be invoked when the operations performed by the DizmeSDK.getStatus method are completed.

    • The it.etuitus.dizme_sdk_aar.models.DizmeSDKStatus status represents the actual status of the Dizme SDK.
    • The it.etuitus.dizme_sdk_aar.errors.DizmeSDKError dizmeSDKError object describes the errors, if occurred, during the execution of the getStatus operation.

  • void onSetLanguageCompleted(boolean setLanguageResult, @Nullable DizmeSDKError dizmeSDKError);:This callback will be invoked when the operations performed by the DizmeSDK.setLanguage method are completed.

    • The boolean setLanguageResult represents the outcome of the setLanguage operation.
    • The it.etuitus.dizme_sdk_aar.errors.DizmeSDKError dizmeSDKError object describes the errors, if occurred, during the execution of the setLanguage operation.

  • void onGetLanguageCompleted(DizmeSDKLanguage language, @Nullable DizmeSDKError dizmeSDKError);:This callback will be invoked when the operations performed by the DizmeSDK.getLanguage method are completed.

    • The it.etuitus.dizme_sdk_aar.models.DizmeSDKLanguagelanguage represents the outcome of the getLanguage operation.
    • The it.etuitus.dizme_sdk_aar.errors.DizmeSDKError dizmeSDKError object describes the errors, if occurred, during the execution of the getLanguage operation.

  • void onGetMaintenanceInfoCompleted(DizmeSDKMaintenanceInfo maintenanceInfo, @Nullable DizmeSDKError dizmeSDKError);:This callback will be invoked when the operations performed by the DizmeSDK.getMaintenanceInfo method are completed.

    • The it.etuitus.dizme_sdk_aar.models.DizmeSDKMaintenanceInfo maintenanceInfo represents the outcome of the getMaintenanceInfo operation.
    • The it.etuitus.dizme_sdk_aar.errors.DizmeSDKError dizmeSDKError object describes the errors, if occurred, during the execution of the getMaintenanceInfo operation.

  • void onOpenNotifyCompleted(boolean openResult, @Nullable DizmeSDKError dizmeSDKError);: This callback will be invoked when the operations performed by the DizmeSDK.openNotify method are completed.

    • The boolean openResult represents the outcome of the openNotify operation.
    • The it.etuitus.dizme_sdk_aar.errors.DizmeSDKError dizmeSDKError object describes the errors, if occurred, during the execution of the openNotify operation.

  • void onGetMyDomainDidCompleted(String myDomainDid, @Nullable DizmeSDKError dizmeSDKError);: This callback will be invoked when the operations performed by the DizmeSDK.getMyDomainDid method are completed.

    • The java.lang.String myDomainDid represents the SDK DID related to the connection with the Domain. * The it.etuitus.dizme_sdk_aar.errors.DizmeSDKError dizmeSDKError object describes the errors, if occurred, during the execution of the getMyDomainDid operation.

  • onNewNotificationReceived(Notify notify, @Nullable DizmeSDKError dizmeSDKError): This callback will be invoked when a new it.etuitus.dizme_sdk_aar.models.Notify was received by the Dizme SDK.

    • it.etuitus.dizme_sdk_aar.models.Notify notify: The it.etuitus.dizme_sdk_aar.models.Notify object received by the SDK.
    • The it.etuitus.dizme_sdk_aar.errors.DizmeSDKError dizmeSDKError object describes the errors, if occurred.

  • void onResetCompleted(boolean resetResult, @Nullable DizmeSDKError dizmeSDKError): This callback will be invoked when the operations performed by the DizmeSDK.reset method are completed.

    • The boolean resetResult represents the outcome of the reset operation.
    • The it.etuitus.dizme_sdk_aar.errors.DizmeSDKError dizmeSDKError object describes the errors, if occurred, during the execution of the reset operation.

  • void onActionFromURLPerformed(boolean result, @Nullable DizmeSDKError dizmeSDKError): This callback will be invoked when the operations performed by the DizmeSDK.performActionFromURL method are completed.

    • The boolean result represents the outcome of the performActionFromURL operation.
    • The it.etuitus.dizme_sdk_aar.errors.DizmeSDKError dizmeSDKError object describes the errors, if occurred, during the execution of the performActionFromURL operation.

  • void onGetNotificationsListCompleted(List<Notify> notificationsList, @Nullable DizmeSDKError dizmeSDKError): This callback will be invoked when the operations performed by the DizmeSDK.getNotificationsList method are completed.

    • The java.util.List<it.etuitus.dizme_sdk_aar.models.Notify> notificationsList represents the outcome of the getNotificationsList operation.
    • The it.etuitus.dizme_sdk_aar.errors.DizmeSDKError dizmeSDKError object describes the errors, if occurred, during the execution of the getNotificationsList operation.

  • void onGetCredentialsListCompleted(String credentialsListJSON, @Nullable DizmeSDKError dizmeSDKError): This callback will be invoked when the operations performed by the DizmeSDK.getCredentialsList method are completed.

    • The java.lang.String credentialsListJSON represents, through a JSON String, the outcome of the getCredentialsList operation.
    • The it.etuitus.dizme_sdk_aar.errors.DizmeSDKError dizmeSDKError object describes the errors, if occurred, during the execution of the getCredentialsList operation.

    Example: {"L1":{"schema_id":"TEST:2:L1:1.1","credential_definition_id":"TEST:3:CL:181552:L1#2.0","attributes":[{"name":"name","mime-type":"text/plain","value":"TEST"},{"name":"surname","mime-type":"text/plain","value":"TEST"},{"name":"birthdate","mime-type":"text/plain","value":"1900-1-1"},{"name":"birthplace","mime-type":"text/plain","value":"TEST"},{"name":"citizenship","mime-type":"text/plain","value":"TEST"},{"name":"credentialIssueTimestamp","mime-type":"text/plain","value":"1600000001"}]}}

  • void onSetAcceptedSchemesCompleted(boolean setAcceptedSchemesResult, @Nullable DizmeSDKError dizmeSDKError): This callback will be invoked when the operations performed by the DizmeSDK.setAcceptedSchemes method are completed.

    • The boolean setAcceptedSchemesResult represents the outcome of the setAcceptedSchemes operation.
    • The it.etuitus.dizme_sdk_aar.errors.DizmeSDKError dizmeSDKError object describes the errors, if occurred, during the execution of the setAcceptedSchemes operation.

  • void onSetAcceptedCredentialDefinitionsCompleted(boolean setAcceptedCredentialDefinitionsResult, @Nullable DizmeSDKError dizmeSDKError): This callback will be invoked when the operations performed by the DizmeSDK.setAcceptedCredentialDefinitions method are completed.

    • The boolean setAcceptedCredentialDefinitionsResult represents the outcome of the setAcceptedCredentialDefinitions operation.
    • The it.etuitus.dizme_sdk_aar.errors.DizmeSDKError dizmeSDKError object describes the errors, if occurred, during the execution of the setAcceptedCredentialDefinitions operation.

  • void onSetNotDeletableSchemesCompleted(boolean setNotDeletableSchemesResult, @Nullable DizmeSDKError dizmeSDKError): This callback will be invoked when the operations performed by the DizmeSDK.setNotDeletableSchemes method are completed.

    • The boolean setNotDeletableSchemesResult represents the outcome of the setNotDeletableSchemes operation.
    • The it.etuitus.dizme_sdk_aar.errors.DizmeSDKError dizmeSDKError object describes the errors, if occurred, during the execution of the setNotDeletableSchemes operation.

DizmeSDKLanguage

Enum which represents the possible language that can be used with the SDK.

Values:

  • en: English language.
  • it: Italian language.
  • fr: French language.

DizmeSDKEnvironment

Enum which represents the possible environment that can be used with the SDK.

Values:

  • MainNet: Production environment.
  • StageNet: Staging environment.
  • BuilderNet: Development environment.

DizmeSDKMaintenanceInfo

This object is useful to provide to the Integrant App the informations about the maintenance (or planned maintenance) of the Dizme SDK. The information contained therein can be used by the Integrant App to provide information to the user about the maintenance that will be carried out on the Dizme SDK.

Below the description of the DizmeSDKMaintenanceInfo methods:

  • getType(): Returns,through an object of type it.etuitus.dizme_sdk_aar.modelsDizmeSDK.MaintenanceType, the type of maintenance.
  • getTitle(): Returns, through an object of type java.lang.String, a title string (localized) related to the maintenance, useful to build a message to show to the user.
  • getMessage(): Returns, through an object of type java.lang.String, a message string (localized) related to the maintenance, useful to build a message to show to the user.
  • getFromDate(): Returns, (if present, otherwise the field is null) through an object of type java.util.Date, the start date of the maintenance operations.
  • getToDate(): Returns, (if present, otherwise the field is null) through an object of type java.util.Date, the end date of the maintenance operations.

DizmeSDKMaintenanceType

Enum which represents the possible type of ongoing maintenance.

Values:

  • MAINTENANCE: SDK is under maintenance. More informations could be retrieved using the getMaintenanceInfo() method of the DizmeSDK object.
  • INFO: This maintenance type is related to a informations about future maintenance or other important informations about the SDK. More informations could be retrieved using the getMaintenanceInfo() method of the DizmeSDK object.
  • FUTURE_MAINTENANCE: A future maintenance is planned. More informations could be retrieved using the getMaintenanceInfo() method of the DizmeSDK object.

DizmeSDKStatus

Enum which represents the possible status of the Dizme SDK obtained by calling the DizmeSDK.getStatus method. Based on the DizmeSDKStatus it will be possible to understand which Dizme SDK init method to invoke, or if an error has occurred.

Values:

  • UNINITIALIZED: Dizme SDK was never initialized before. It is the case of first init of the SDK. Then, if the status is UNINITIALIZED the createWallet method of the DizmeSDK object must be called.
  • INITIALIZED: The SDK is already initialized. This is the case of every SDK init following the first one (for example, every execution of the integrant Application). So, if the state is INITIALIZED, the openWallet method of the DizmeSDK object must be called.
  • ERROR: Dizme SDK is in Error. A critical error has occurred. The SDK cannot be started.

DizmeSDKInitStatus

Enum which represents the possible status reached as a result of running one of the DizmeSDK init methods (createWallet or openWallet). Each init method invoked will then return the reached status or an error.

Values:

  • INITIALIZED: Status reached if the init operations invoked by the createWallet method of the DizmeSDK object was successful.
  • STARTED: Status reached if the init operations invoked by the openWallet method of the DizmeSDK object was successful.
  • RECOVERED: Status reached if the init operations invoked by the initializeSDKFromBackup method of the DizmeSDK object was successful.
  • ERROR: An error occurred while executing of an init method. Further details will be provided through the DizmeSDKInitResult object.

DizmeSDKInitResult

Object useful to handle the result of the init methods of the DizmeSDK object: createWallet, openWallet, initializeSDKFromBackup.

Below the description of the DizmeSDKInitResult methods:

  • getInitStatus(): Returns,through an object of type DizmeSDKInitStatus, the result status of an init method.
  • getInitError(): Returns, (if present, otherwise the field is null) through an object of type DizmeSDKInitError, the type of error that occurred while executing one of the init methods.
  • getErrorDetails(): Returns, (if present, otherwise the field is null) through an object of type java.lang.String a String (localized) that provides a description of the occurred error while executing one of the init methods.
  • getErrorSpecific(): Returns, (if present, otherwise the field is null) through an object of type DizmeSDKInitErrorSpecific, more details about the occurred error.

DizmeSDKError

Enum which represents the possible error occurred during the executions of the Dizme SDK methods.

Values:

  • CRITICAL: Critical internal error occurred.
  • GENERIC: Generic error occurred.
  • BACKUP_ERROR: An error occurred during the wallet backup procedure.
  • INVALID_SDK_STATUS: Error, Dizme SDK is it is not in the correct state to be able to perform the required functionality. Check it.etuitus.dizme_sdk_aar.models.DizmeSDKStatus value.
  • NOT_READY: Error, Dizme SDK is still not ready to use. Try to call the DizmeSDK.getStatus method again and check it.etuitus.dizme_sdk_aar.models.DizmeSDKStatus value.
  • INVALID_INPUT_PARAMETERS: Error, wrong parameters provided to the method. Check input parameters.
  • NETWORK_ERROR: Network Error. Check internet connection.
  • URL_NOT_VALID_ERROR: The URL provided is not valid for the Dizme SDK.

DizmeSDKInitError

Enum which represents the possible error occurred during the executions of the init methods of the Dizme SDK.

Values:

  • CRITICAL: Critical internal error occurred.
  • REGISTRATION_ERROR: Generic error occurred during the Registration phase.
  • INITIALIZE_WALLET_ERROR: Generic error occurred during the Initialize Wallet phase.
  • RECOVERY_WALLET_ERROR: Generic error occurred during the Recovery Wallet phase.
  • NETWORK_ERROR: Network Error. Check internet connection.
  • WRONG_PIN_ERROR: Error, a wrong wallet PIN was provided
  • INVALID_SDK_STATUS: Error, Dizme SDK is it is not in the correct state to be able to perform the required functionality. Check it.etuitus.dizme_sdk_aar.models.DizmeSDKStatus value.
  • INVALID_INPUT_PARAMETERS: Error, wrong parameters provided to the method. Check input parameters.
  • NOT_READY: Error, Dizme SDK is still not ready to use. Try to call the DizmeSDK.getStatus method again and check it.etuitus.dizme_sdk_aar.models.DizmeSDKStatus value.
  • LOGIN_ERROR: Login error occurs during the DizmeSDK.openWallet phase.
  • RESET_NEEDED: An error occurs during the DizmeSDK.openWallet or the DizmeSDK.initializeSDKFromBackup phase. In this case, the Wallet is already installed on other device and will be deleted on the current device.
  • MAINTENANCE: Dizme is under maintenance. The SDK cannot be started. More informations about the maintenance can be retrieved through the getMaintenanceInfo() method of the DizmeSDK object. This status was returned in case of maintantenance of type (DizmeSDKMaintenanceType) MAINTENANCE. However, it is convenient to invoke the getMaintenanceInfo() method of the DizmeSDK object before each call to the DizmeSDK object's init method (createWallet, openWallet, initializeSDKFromBackup). This is because in addition to blocking maintenance, a it.etuitus.dizme_sdk_aar.models.DizmeSDKMaintenanceInfo object could be returned concerning a future planned maintenance (DizmeSDKMaintenanceType.FUTURE_MAINTENANCE) or a maintenance Info message could be returned. The latters is used by the SDK to communicate important information while not blocking the SDK from starting.

DizmeSDKInitErrorSpecific

Enum which represents more informations regarding the possible error occurred during the executions of the init methods of the Dizme SDK.

Values:

  • CRTITICAL_ERROR: Critical internal error occurred.
  • NETWORK_ERROR: Network Error. Check internet connection.
  • BLOCKCHAIN_UNREACHABLE: Error, Blockchain is unreachable.
  • BLOCKCHAIN_UNREACHABLE_TIMEOUT: Error, Blockchain is unreachable for timeout.
  • BLOCKCHAIN_UNREACHABLE_VPN: Error, Blockchain is unreachable for presence of Firewall or VPNs.
  • WRONG_CREDENTIALS: Error, elements used for the wallet recovery (wallet backup file and/or wallet passphrase) are wrong.

Notify

Object useful to describe an incoming notification.

Below the description of the Notify (it.etuitus.dizme_sdk_aar.models.Notify) getter methods:

  • getId(): Returns,through an object of type String, the notify's Id
  • getTitle(): Returns,through an object of type String, the notify's Title
  • getMessage(): Returns,through an object of type String, the notify's Message
  • getCreated(): Returns,through an object of type java.util.Date, the notify's creation Date
  • getData(): Returns,through an object of type Map<String, T>, the notify's (optional) additional Data
  • getType(): Returns,through an object of type it.etuitus.dizme_sdk_aar.models.NotificationType, the notify's Type

Below an example of Notification's List (from toString() method): [Notify{title='A message from Company', message='test', created=Wed May 17 11:58:07 GMT+02:00 2023, id='4ed67182-f499-11ed-8c55-ea44f1e66170', type=INFO, data={}}, Notify{title='Issue credential TEST', message='Company offers you the credential TEST', created=Wed May 17 11:58:52 GMT+02:00 2023, id='229e7006-dd1e-48eb-8d3f-7906a0f69aad', type=ISSUE_CREDENTIAL, data={schema_id=TEST:2:L1:1.1, credential_definition_id=TEST:3:CL:181552:L1#2.0}}]

NotificationType

An Enum that represents the type of the incoming notification (it.etuitus.dizme_sdk_aar.models.Notify).

Values:

  • ISSUE_CREDENTIAL: The incoming notification is related to an issue of a Credential. In this case, the Map obtained using the getData() method described above will contain two Strings related to the Credential, object of the notification. Specifically, therefore, the Credential Definition Id (credential_definition_id) and the Schema Id (schema_id) will be present (see the Example above).
  • PROOF_REQUEST: The incoming notification is related to a Proof Request
  • INFO: The incoming notification is an info message for the user

Use of DizmeSDK

To use DizmeSDK it is necessary to instantiate an object of the type it.etuitus.dizme_sdk_aar.DizmeSDK.

Once the it.etuitus.dizme_sdk_aar.DizmeSDK type object has been instantiated,the getStatus method must be invoked.

Before proceding further, regarding the output of the getStatus method, available through the callback DizmeSDKCallback.onGetStatusCompleted(DizmeSDKStatus status, @Nullable DizmeSDKError dizmeSDKError), the integrating Application must not proceed in calling other methods related to the it.etuitus.dizme_sdk_aar.DizmeSDK object before the DizmeSDKStatus hasn't value different from DizmeSDKError.NOT_READY or if DizmeSDKError hasn't value different from DizmeSDKStatus.ERROR.

Then, later, when the getStatus method ends with values different from that described above, the integrant Application can invoke the init methods of the SDK using the method createWallet or the method openWallet, regarding the value of the DizmeSDKStatus (INITIALIZED, UNINITIALIZED), as described in the sections above.

When on of the two callback methods (onCreateWalletCompleted or onOpenWalletCompleted) will be called, dependently from the init method chosen (createWallet or openWallet), the startDizme method may be invoked. At the end of start operations, the onStartCompleted callback will be invoked.

At this point the Dizme SDK will be ready to be viewed.

Then, using the getDizmeSDKFragment method, can be recovered the Fragment in which the Dizme SDK will be displayed and can be the positioned the latter in the appropriate View of the Integrant App chosen for viewing Dizme SDK.

Since the operations described above, createWallet/openWallet and startDizme, may take some time, it would be advisable to execute them at the startup of the Integrating App in order to have, at the end of the startup, the Fragment ready to be displayed (Dizme SDK already initialized and ready). If the Fragment should be displayed before the end of the operations described above, a view containing a progress bar will be displayed.

Setting of Auto-Accept and Not Delete Incoming Credentials

If the Integrating Application wants to use one of the setAcceptedSchemes,setAcceptedCredentialDefinitions and/or setNotDeletableSchemes methods listed in the API Description paragraph, it is advisable to invoke the desired method as soon as the SDK status is DizmeSDKInitStatus.INITIALIZED to be sure that these parameters have been set before receive any credential.

Therefore for the first initialization they can be invoked within the callback onCreateWalletCompleted or onInitializeSDKFromBackup (as soon as the SDK state is DizmeSDKInitStatus.RECOVERED) in case of Wallet recovery.

Once the desired values have been set, they remain stored until the App is uninstalled from the device.

In case the integrating Application wants to specify, after the first initialization, different values for the Schema Id or Credential Definition Id, integrating Application can invoke the related methods within the onOpenWalletCompleted callback (as soon as the SDK status is DizmeSDKInitStatus.STARTED). In this way the previously indicated values will be overwritten.

Use of DizmeSDK - Example:

Below an example (incomplete) of an Android AppCompatActivity Activity (MainActivity.java).

It is an activity that contains two Fragments: HomeFragment and DizmeFragment. The latter will display the Dizme SDK once initialized:

public class MainActivity extends AppCompatActivity implements DizmeSDKCallback, DizmeSDKInitCallback{
    BottomNavigationView bottomNavigation;
    private static DizmeSDK dizmeSDK;
    private static final String CL = "MainActivity - ";


    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);
        Log.d(CL, "On Create");
        ActionBar bar = getSupportActionBar();
        bar.setBackgroundDrawable(new ColorDrawable(Color.parseColor("#0181C8")));
        bottomNavigation = findViewById(R.id.bottom_navigation);
        bottomNavigation.setOnNavigationItemSelectedListener(navigationItemSelectedListener);
        try {
            dizmeSDK = new DizmeSDK(getApplicationContext());
        } catch (Exception exception) {
            exception.printStackTrace();
        }
        openFragment(HomeFragment.newInstance("", ""));
        dizmeSDK.getStatus(this);
    }

    public void openFragment(Fragment fragment) {
        FragmentTransaction transaction = getSupportFragmentManager().beginTransaction();
        transaction.replace(R.id.container, fragment);
        transaction.addToBackStack(null);
        transaction.commit();
    }



    BottomNavigationView.OnNavigationItemSelectedListener navigationItemSelectedListener =
            new BottomNavigationView.OnNavigationItemSelectedListener() {
                @Override
                public boolean onNavigationItemSelected(@NonNull MenuItem item) {
                    switch (item.getItemId()) {
                        case R.id.navigation_home:
                            openFragment(HomeFragment.newInstance("", ""));
                            return true;
                        case R.id.navigation_sms:
                            openFragment(DizmeFragment.newInstance(dizmeSDK));
                            return true;

                    }
                    return false;
                }
            };

    @Override
    public void onCreateWalletCompleted(DizmeSDKInitResult dizmeSDKInitResult) {
        Log.d(CL, "onCreateWalletCompleted");
        if (dizmeSDKInitResult.getInitStatus() == DizmeSDKInitStatus.INITIALIZED) {
            dizmeSDK.startDizme(this, null);
        }
    }

    @Override
    public void onOpenWalletCompleted(DizmeSDKInitResult dizmeSDKInitResult) {
        Log.d(CL, "onOpenWalletCompleted");
        Log.d(CL, "DizmeSDKInitResult " + dizmeSDKInitResult.toString());
        if (dizmeSDKInitResult.getInitStatus() == DizmeSDKInitStatus.STARTED) {
            dizmeSDK.startDizme(this, null);
        }
    }

    @Override
    public void onStartCompleted(boolean startResult, @Nullable DizmeSDKInitError dizmeSDKInitError) {
        Log.d(CL, "onDizmeSDKStartCompleted: " + startResult);
        // TODO IMPLEMENT...
    }


    @Override
    public void onGetStatusCompleted(DizmeSDKStatus status, @Nullable DizmeSDKError dizmeSDKError) {
        if (status == DizmeSDKStatus.UNINITIALIZED) {
            dizmeSDK.createWallet("Kjufhte7557ujf@oolzzh",DizmeSDKEnvironment.StageNet,
                   DizmeSDKLanguage.en,
                   "NOT_A_REAL_TOKEN_57757ifinisnvdcsdcdscdsndosncwscunrsNOEWndonwdanIUNFWIRFNadskldnweadocsnd",
                   "dizme_invitation_url",
                   "dizme",this);
			  return;
        }
        if (status == DizmeSDKStatus.INITIALIZED) {
              dizmeSDK.openWallet("Kjufhte7557ujf@oolzzh",
                    "NOT_A_REAL_TOKEN_57757ifinisnvdcsdcdscdsndosncwscunrsNOEWndonwdanIUNFWIRFNadskldnweadocsnd",
                    this);
        }
    }
  
    //..........

}

Below an example of an Android AppCompatActivity Activity related layout file (activity_main.xml):

<?xml version="1.0" encoding="utf-8"?>
<RelativeLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:app="http://schemas.android.com/apk/res-auto"
    xmlns:tools="http://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    tools:context=".MainActivity">

    <FrameLayout
        android:id="@+id/container"
        android:layout_alignParentTop="true"
        android:layout_width="match_parent"
        android:layout_height="620dp">
    </FrameLayout>

    <com.google.android.material.bottomnavigation.BottomNavigationView
        android:id="@+id/bottom_navigation"
        android:layout_below="@id/container"
        android:layout_width="match_parent"
        android:layout_height="wrap_content"
        android:layout_gravity="bottom"
        android:background="#0181C8"
        app:itemIconTint="@color/white"
        app:itemTextColor="@color/white"
        app:menu="@menu/bottom_nav" />
</RelativeLayout>

Below an example (incomplete) of the DizmeFragment Fragment (DizmeFragment.java):

private Button startDizmeButton;
    private static DizmeSDK dizmeSDKInternal;

    public DizmeFragment() {
    }


    public static DizmeFragment newInstance(DizmeSDK dizmeSDK) {
        DizmeFragment fragment = new DizmeFragment();
        dizmeSDKInternal = dizmeSDK;
        return fragment;
    }

    @Override
    public void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
    }


    @Override
    public View onCreateView(LayoutInflater inflater, ViewGroup container,
                             Bundle savedInstanceState) {
        return inflater.inflate(R.layout.fragment_dizme, container, false);
    }

    @Override
    public void onViewCreated(@NonNull View view, @Nullable Bundle savedInstanceState) {
        super.onViewCreated(view, savedInstanceState);
        startDizmeButton = (Button) getView().findViewById(R.id.start_dizme_button);
        startDizmeButton.setOnClickListener(new View.OnClickListener() {
            @Override
            public void onClick(View view) {
                showdizmefragment();
            }
        });
    }

    public void showdizmefragment() {
        getActivity().getSupportFragmentManager().beginTransaction()
                .replace(R.id.container, dizmeSDKInternal.getDizmeSDKFragment(), "findThisFragment")
                .addToBackStack(null)
                .commit();

    }

Below an example of the DizmeFragment Fragment related layout file (fragment_dizme.xml):

<?xml version="1.0" encoding="utf-8"?>
<RelativeLayout xmlns:android="http://schemas.android.com/apk/res/android"
    xmlns:tools="http://schemas.android.com/tools"
    android:layout_width="match_parent"
    android:layout_height="match_parent">


    <Button
        android:id="@+id/start_dizme_button"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        android:layout_centerInParent="true"
        android:text="Start Dizme"
        android:textAllCaps="false"></Button>
</RelativeLayout>

Customization of DizmeSDK

Some characteristics of the SDK can be customized. To do this, the Integrating Application must add a JSON file with the name dizme_sdk_config.json to the path app/src/main/assets/flutter_assets/dizme/

Within the latter, by adding the defined keys, with the relative values, it is possible to customize some aspects of the SDK.

Below, the description of the currently customizable aspects with the indication of the key to be inserted inside the JSON object and the relative value.

  • Primary color of the SDK's views:
    • Key: primaryColor
    • Value: string. Color to be set, as Hex String.
    • Default value: "#0181C8"
  • Secondary color of the SDK's views:
    • Key: secondaryColor
    • Value: string. Color to be set, as Hex String.
    • Default value: "#0A4B8F"
  • Text color used on Primary Color:
    • Key: textColorOnPrimary
    • Value: string. Color to be set, as Hex String.
    • Default value: "#FFFFFF"
  • Show/Hide Top portion of the Home Page (Including Avatar and Username label):
    • Key: show_only_credentials_on_home_page
    • Value: boolean. If true, only the credential list will be shown on the HomePage.
    • Default value: false

Below an example of the JSON file (dizme_sdk_config.json):

{
  "show_only_credentials_on_home_page":true,
  "primaryColor" : "#006F98",
  "textColorOnPrimary" :"#FFFFFF",
  "secondaryColor":"#0B2E4F"
}
Back to top