Install the Kotlin SDK

Add io.realm.kotlin, specifying the library version and apply false, to the list of plugins in your project-level Gradle build file, typically found at <project>/build.gradle:

plugins {
   id 'io.realm.kotlin' version '1.16.0' apply false
}

Add the following to your app-level Gradle build file, typically found at <project>/app/build.gradle:

• Add io.realm.kotlin to the list of plugins.

• Add the following to the list of dependencies:

  • Add io.realm.kotlin:library-base to the dependencies block.

  • If using Device Sync in your application, add io.realm.kotlin:library-sync to the dependencies block.

• To use coroutines with the SDK, add org.jetbrains.kotlinx:kotlinx-coroutines-core to the list of dependencies.

plugins {
   id 'com.android.application'
   id 'org.jetbrains.kotlin.android'
   id 'io.realm.kotlin'
}
android {
   // ... build configuration settings
}
dependencies {
   implementation 'io.realm.kotlin:library-base:1.16.0'
   // If using Device Sync
   implementation 'io.realm.kotlin:library-sync:1.16.0'
   // If using coroutines with the SDK
   implementation 'org.jetbrains.kotlinx:kotlinx-coroutines-core:1.7.0'
}

1. Add the following to your app-level Gradle build file, typically found at <project>/app/build.gradle:

   • Add io.realm.kotlin to the list of plugins.

   • Add the following to the list of dependencies:

     • Add io.realm.kotlin:library-base to the dependencies block.

     • If using Device Sync in your application, add io.realm.kotlin:library-sync to the dependencies block.

   • To use coroutines with the SDK, add org.jetbrains.kotlinx:kotlinx-coroutines-core to the list of dependencies.

   App build.gradle

   plugins {
      kotlin("multiplatform")
      kotlin("native.cocoapods")
      id("com.android.library")
      id("io.realm.kotlin") version "1.16.0"
   }
   version = "1.0"
   kotlin {
      android()
      iosX64()
      iosArm64()
      sourceSets {
         val commonMain by getting {
            dependencies {
               implementation("io.realm.kotlin:library-base:1.16.0")
               // If using Device Sync
               implementation("io.realm.kotlin:library-sync:1.16.0")
               // If using coroutines with the SDK
               implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.7.0")
            }
         }
      }
   }

2. If you use any part of the SDK inside the Android module, add the following compile-time dependencies to your module-level Gradle build file, typically found at <project>/module/build.gradle:

   Android Module build.gradle

   dependencies {
      compileOnly("io.realm.kotlin:library-base:1.16.0")
   }
   // If using Device Sync
   dependencies {
      compileOnly("io.realm.kotlin:library-sync:1.16.0")
   }