dtx-lib-ui-learning-android-sdk

dtx-lib-ui-learning-android-sdk is an Android UI-Learning library for DTx Application. This library is published on JitPack and can be easily integrated into your Android projects. It is written in Kotlin and is released under the MIT License.

Table of Contents

• Installation
• Usage
• Contributing
• License

Installation

To use dtx-lib-ui-learning-android-sdk in your project, add the following to your project-level build.gradle or setting.gradle file:

allprojects {
    repositories {
        ...
        maven { url "https://jitpack.io" }
    }
}

Next, add the following dependency to your module-level build.gradle file:

def UI_LEARNING_SDK_VERSION = LATEST_JITPACK_VERSION_OF_SDK

dependencies {
    implementation "com.github.weltcorp:dtx-lib-ui-learning-android-sdk:$UI_LEARNING_SDK_VERSION"
}

Make sure to replace YourUsername with your actual GitHub username.

Usage

- Initialize

After adding the library to your project, you have to initialize first in your Application before use the SDK.

class YourCustomApplication: Application() {
    override fun onCreate() {
        super.onCreate()

        try {
            // Initialize the Learning SDK
            WeltDtxLearning.init(
                application = this,
                env = BuildConfig.BUILD_ENV, // Set in build.gradle(:app)
                appToken = "APP_TOKEN",
                serviceName = "SERVICE_NAME",
                projectId = "APP_PROJECT_ID",
            )
        } catch (e: Exception) {
            e.printStackTrace()
        }
    }
}

- Open LearningLesson

Open learning contents page with lesson_id.

{
    // Open the Learning contents page
    WeltDtxLearning.openLearningLesson(
        onCompleteLessonListener = object : OnCompleteLessonListener {
            override fun onComplete() {
                // Do something when user complete the lesson
            }
        },
        routeName = "learning-pages",
        lessonId = LESSON_ID,
        userId = USER_ID,
    )
}

License

dtx-lib-ui-learning-android-sdk is released under the MIT License. See the LICENSE file for more details.