Clix Documentation

Before Getting Started

Overview

Clix leverages Firebase Cloud Messaging (FCM) to deliver notifications efficiently. The goal is to ensure a smooth integration process and reliable delivery of push notifications to your app users.

Environment

Android API level 26 (Android 8.0) or later
Firebase account

Make sure you’ve completed the Firebase setup.

If the setup is complete, the following items should be in place.

Make sure google-services.json is in your project directory.
Upload the Service Account Key file to the Clix console.

Setup Clix - Using CLI (Recommended)

Clix provides a Homebrew CLI for quick and easy setup.

Use the install and doctor commands to automatically configure the required code and settings. For iOS projects, follow the CLI prompts to add the necessary files and configurations.

Install Clix CLI

homebrew tap clix-so/clix-cli
homebrwe install clix-so/clix-cli/clix

Run Install Command

The install command in the Clix CLI checks for required files and configurations, and provides appropriate installation guidance through prompts.

clix install

Doctor Command

The clix doctor command checks whether the necessary code and configuration for using the Clix SDK are properly set up, and provides guidance on how to fix any issues.

clix doctor

Setup Clix - Manual Installation

Integrate Firebase and Clix to manage and send notifications effectively from Clix console.

1. Installation

Clix Android SDK supports installation only via Gradle (Kotlin DSL).

Add the following to your project’s settings.gradle.kts or build.gradle.kts:

repositories {
    mavenCentral()
}

Add the dependency to your app’s build.gradle.kts:

dependencies {
    implementation("so.clix:clix-android-sdk:1.0.0")
}

Lastly, add the plugin to your app’s build.gradle.kts :

plugins {
    id("com.google.gms.google-services") version "4.4.2"
}

2. Initialize Clix with Config

Add this code to Application Class. The enpoint and logLevel parameters are optional.

import so.clix.core.Clix
import so.clix.core.ClixConfig
import so.clix.utils.logging.ClixLogLevel

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

		Clix.initialize(
            this,
            ClixConfig(
                projectId = "YOUR_PROJECT_ID",
                apiKey = "YOUR_API_KEY",
            ),
        )
    }
}

You also need to integrate the code for requesting notification permissions. Add the code below to your Activity file and call this function when you want to prompt the user for notification permission.

If you don’t have a specific preference, we recommend adding it to MainActivity.kt and calling it inside the onCreate method.

// If you have missing dependencies, import dependencies below.
// import android.Manifest
// import android.content.pm.PackageManager
// import android.os.Build
// import androidx.activity.result.contract.ActivityResultContracts
// import androidx.core.content.ContextCompat

private val requestPermissionLauncher =
        registerForActivityResult(ActivityResultContracts.RequestPermission()) { isGranted: Boolean
        ->
//             Handle permission result if needed
    }

private fun checkAndRequestNotificationPermission() {
    val isTiramisuOrHigher = Build.VERSION.SDK_INT >= Build.VERSION_CODES.TIRAMISU
    if (!isTiramisuOrHigher) {
        return
    }
    val hasNotificationPermission =
        ContextCompat.checkSelfPermission(this, Manifest.permission.POST_NOTIFICATIONS) ==
            PackageManager.PERMISSION_GRANTED
    if (!hasNotificationPermission) {
        requestPermissionLauncher.launch(Manifest.permission.POST_NOTIFICATIONS)
    }
}

3. Build & Run

Setup Firebase

You need to set up Firebase before you start integrating it into your project.

Clix Sample Project - Android

If you’d like to see a working example, check out our sample project.

User Guide

API Reference

Trouble Shooting

SDK Quickstart - Android

Before Getting Started

Overview

Environment

Setup Clix - Using CLI (Recommended)

Install Clix CLI

Run Install Command

Doctor Command

Setup Clix - Manual Installation

Setup Firebase

Clix Sample Project - Android

User Guide

API Reference

Trouble Shooting

​Before Getting Started

​Overview

​Environment

​Setup Clix - Using CLI (Recommended)

​Install Clix CLI

​Run Install Command

​Doctor Command

​Setup Clix - Manual Installation

Setup Firebase

Clix Sample Project - Android

Before Getting Started

Overview

Environment

Setup Clix - Using CLI (Recommended)

Install Clix CLI

Run Install Command

Doctor Command

Setup Clix - Manual Installation