Package io.seald.seald_sdk

:::warning This package is still early-access:

  • the interface will probably still have breaking changes

  • the installation instructions may change in the future

  • some quality-of-life features are still missing

  • some bugs may still be present

  • the documentation may still be incomplete, or not very readable

Feel free to give us feedback! :::

This package is the Seald SDK for Android.

To install it, you need to add the package io.seald:seald_sdk_android, available on Maven Central, to your dependencies.

The current version is ##VERSION##. Here is how you can add it to your app/build.gradle:

dependencies {
    /* ... */
    implementation 'io.seald:seald_sdk_android:##VERSION##'
}

You can then import it in your code with:

import io.seald.seald_sdk.SealdSDK

You can also see the example app.

This package contains the main SealdSDK class, the EncryptionSession class, as well as multiple helper classes.

SealdSDK is the main class for the Seald SDK. It represents an instance of the Seald SDK.

You can instantiate it this way:

val seald = SealdSDK(
    apiURL = "https://api.seald.io/",
    appId = "YourAppId",
    databasePath = "/myApp/seald_db",
    databaseEncryptionKey = "A Secret Key to encrypt the local database, encoded in b64"
)

This class then allows you to create an account, create or retrieve an EncryptionSession, etc.

See the SealdSDK reference for more information.

An EncryptionSession allows you to encrypt / decrypt multiple messages or files.

This should not be instantiated directly, and should be either created with SealdSDK.createEncryptionSession or retrieved with SealdSDK.retrieveEncryptionSession or SealdSDK.retrieveEncryptionSessionFromMessage.

© 2023 Seald SAS

You can find the license information of Open Source libraries used in Seald SDK for mobile at https://download.seald.io/download/mobile_dependencies_licenses_##VERSION##.txt.

See: Description