SDK Initialization

License Key

The Docutain SDK for Android needs a valid, non-expired license key in order to work. The license key is bound to the applicationId defined in your app's build.gradle file. Any attempt to use a license key in an app with a different applicationId will fail.

Trial license

The Docutain SDK is a commercial product and requires a paid license for production use. In order to get a trial license, please visit our website via https://sdk.docutain.com/TrialLicense to generate a trial license key.

Production license

To get information about the SDK's functionality and pricing and to purchase a production license, please contact us.

Initialize the SDK

In order to use any functionality of the SDK, you must initialize it first. Add the following code to your MainActivity class:

Kotlin

import de.docutain.sdk.DocutainSDK;

class MainActivity : AppCompatActivity() {

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        if(!DocutainSDK.initSDK(this.application, "YOUR_LICENSE_KEY")){
            //init of Docutain SDK failed, get the last error message
            val error = DocutainSDK.getLastError()
            //your logic to deactivate access to SDK functionality
        }
    }
}

Java

import de.docutain.sdk.DocutainSDK;

public class MainActivity extends AppCompatActivity {

  @Override
  protected void onCreate(Bundle savedInstanceState) {
      super.onCreate(savedInstanceState);
      if(!DocutainSDK.initSDK(this.getApplication(), "YOUR_LICENSE_KEY")){
          //init of Docutain SDK failed, get the last error message
          String error = DocutainSDK.getLastError();
          //your logic to deactivate access to SDK functionality
          //...
      }
  }
}

caution

If the initialization fails, you are responsible to deactivate access to SDK functionality.

Logging

The SDK writes certain information into a log file. You can get the log file by calling Logger.getTraceFile(). You can send this log file to us if you have any issues/bugs with the SDK. The Logger has certain levels that you can set depending on your needs. However, we suggest to leave the level to it's default value which ensures that in case of any issues/bugs we can get all the information we need from you.

Kotlin

//get the log file
val logFile = Logger.getTraceFile()

//set the log level
Logger.setLogLevel(Logger.Level.VERBOSE)

Java

//get the log file
File logFile = Logger.getTraceFile();

//set the log level
Logger.setLogLevel(Logger.Level.VERBOSE);

Depending on the log level, some temporary files get written. These files, if any, will be deleted everytime the SDK starts, so you don't need to worry about spamming the files dir.

If you like, you can delete these files manually by using DocutainSDK.deleteTempFiles().