KIterable Kotlin SDK

Iterable + Kotlin = KIterable

The KIterable Kotlin SDK is a Kotlin-first SDK for Iterable. Its API is similar to the Iterable Android SDK but also supports multiplatform projects, enabling you to use Iterable directly from your common source targeting iOS and Android.

Installation

KMM

implementation("com.myunidays:kiterable:0.0.13")

Android

implementation("com.myunidays:kiterable-android:0.0.13")

iOS

Add to the binary to your swift package like this:

        .binaryTarget(
            name: "kiterable",
            url: "https://github.com/MyUNiDAYS/KIterable/releases/download/0.0.13/0.0.13.zip",
            checksum: "8c35293a410f4ec5d150c4f5464f6b5cf04a1a15d1ae9c29126bb0b7a7dc2a54"
        ),

Where 0.0.13 is the release number, you will also need to change the checksum, xcode will tell you the different checksum if its wrong and just update that from the error message.

How to use

KMM & Android

Initialise the lib, in the case for Android, context is ContextWrapper, which you get from application context.

IterableApi.initialize(context, apiKey = "123", config: IterableConfig())

Then call the api - its very similiar to the Android api.

IterableApi.getInstance().setUserId("billyBob")

iOS

When using the library in iOS, you MUST implement the IterableApiInterface

class KiterableApi: IterableApiInterface {

Then you can call this file with the iterable api requests.

kiterableApi.setUserId(userId: "billyBob")

Contributing

This project is set up as an open source project. As such, if there are any suggestions that you have for features, for improving the code itself, or you have come across any problems; you can raise them and/or suggest changes in implementation.

If you are interested in contributing to this codebase, please follow the contributing guidelines. This contains guides on both contributing directly and raising feature requests or bug reports. Please adhere to our code of conduct when doing any of the above.