Segmenkt
0.0.8indexedKotlin-first SDK for integrating Segment analytics, supporting tracking, identifying, grouping, and screen operations in multiplatform projects targeting iOS and Android.
0
Stars
—
Used by
dependents
—
Health
/ 100
SegmenKT Kotlin SDK 
Segment + Kotlin = SegmenKT
The SegmenKT Kotlin SDK is a Kotlin-first SDK for Segment. Its API is similar to the Segment Android SDK but also supports multiplatform projects, enabling you to use Segment directly from your common source targeting iOS and Android.
Installation
KMM
implementation("com.myunidays:segmenkt:0.0.9")
Android
implementation("com.myunidays:segmenkt-android:0.0.9")
iOS
Run gradle task in this project
./gradlew assembleXCFramework
Locate the framework in the following directory
build/XCFrameworks/
Add the xcframework file to your xcode project
JS
At the moment there is a JS target but it is currently filled with TODO's so it's not recommended to be used yet.
Important
In order for ios to work you will also need to include the segment framework to your ios project.
How to use
Initialise segment with a config
Kotlin
val segmentConfig = Configuration(
writeKey = WriteKey(
android = "123",
ios = "ABC",
js = "1"
),
context = context
)
Analytics.setupWithConfiguration(segmentConfig)
No need to define a key for iOS if you are using just Android.
Swift
let segmentConfig = Configuration(writeKey: WriteKey(android: nil, ios: "", js: nil), context: nil)
Analytics.Companion().setupWithConfiguration(configuration: segmentConfig)
Then when you want to Track, Identify, Group, Screen
Kotlin
Analytics.shared().track("Cool Event")
Analytics.shared().identify("1")
Analytics.shared().group("1")
Analytics.shared().screen("Cool Screen")
Swift
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.