DataArt Android Client

DataArt platform client for Android.

Getting Started

Add jitpack.io repository to your root build.gradle file:

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

Now add the following dependency to your app build.gradle file:

dependencies {
    implementation 'com.github.dataart-ai:dataart-android:v0.1.0'
}

Usage

Client instance requires a set of configurations passed by the DataArt.Config object. Default values are set for all of them except apiKey. You can start sending requests if no exceptions were raised in the initialization process. Keep in mind, no internal singleton pattern is developed by the client itself. It's up to you to manage your running instance.

val dataart = DataArt(appContext, DataArt.Config("your-api-key"))

You can customize configurations using DataArt.Config object:

Config(
    /**
    * The authorization key for sending requests. You can find this value
    * in your dashboard. Contact support if you need help.
    */
    val apiKey: String,
    /**
    * The number of times each request is tried before giving up.
    */
    val flushNumRetries: Int = DEFAULT_FLUSH_NUM_RETRIES,
    /**
    * The constant time (seconds) added for each execution retry. For instance
    * a flushNumRetries of 3 and flushBackoffRatio of 10 will cause in 10, 20, 30 seconds
    * of delay before giving up.
    */
    val flushBackoffRatio: Long = DEFAULT_FLUSH_BACKOFF_RATIO,
    /**
    * The number of action events in batch request. If you emit
    * this much actions, a request will be created and sent.
    */
    val flushActionsBatchSize: Int = DEFAULT_FLUSH_ACTIONS_BATCH_SIZE,
    /**
    * The timer duration (milliseconds) for flushing actions. If this much time is passed
    * and there's some actions left, they will be sent to server.
    */
    val flushInterval: Long = DEFAULT_FLUSH_INTERVAL
)

Emit Action

dataart.emitAction(
    "some-event-key",
    "some-user-key",
    false,
    Date(),
    mapOf()
)

Identify

dataart.identify("some-user-key", mapOf())

Full Example

import android.os.Bundle
import android.view.View
import androidx.appcompat.app.AppCompatActivity
import com.datartproject.dataart.client.DataArt
import java.util.Date

class MainActivity : AppCompatActivity() {
    private lateinit var dataart: DataArt

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)

        dataart = DataArt(this, DataArt.Config("your-api-key"))
    }

    fun onButtonClicked(v: View) {
        if (v.id == R.id.btn) {
            dataart.emitAction(
                "some-event-key",
                "some-user-key",
                false,
                Date(),
                mapOf()
            )
        }
    }
}

License

MIT License

Copyright (c) 2021 DataArt

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.