Kotlin SDK

Installation

Gradle (Kotlin DSL)

Add the artifact from Maven Central to your module-level build.gradle.kts. These lines install version 1.0.1; see Versions above for what this page covers.

repositories {
    mavenCentral()
}

dependencies {
    implementation("com.getfeedbackkit:feedbackkit:1.0.1")
}

Gradle (Groovy)

The same coordinates in a Groovy build.gradle:

repositories {
    mavenCentral()
}

dependencies {
    implementation 'com.getfeedbackkit:feedbackkit:1.0.1'
}

Quick Start

Configure FeedbackKit once, from your Application, then display the feedback list. The lambda below is FeedbackKitConfig.Builder, so the options are method calls. The other overload, configure(context) { apiKey = "…" }, assigns properties and needs import com.swiftlydeveloped.feedbackkit.configure. A second configure in the same process returns the first instance.

import com.swiftlydeveloped.feedbackkit.*

class MainActivity : ComponentActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)

        FeedbackKit.configure(this, "your-api-key") {
            userId("user_12345")
            environment(Environment.PRODUCTION)
        }

        setContent {
            FeedbackList(
                onFeedbackClick = { feedback ->
                    // Navigate to detail
                }
            )
        }
    }
}

On 2.1.0, omit userId and configure stores local_ plus a lowercase UUID in private SharedPreferences (feedbackkit_user_id). List, submit, vote, unvote, and comment send that id. Maven 1.0.1 does not generate it, and a vote with no id throws a validation error. Assign FeedbackKit.shared.userId to replace it. logout() clears SharedPreferences and DataStore. The next process start generates a new id only when both stores are empty.

Configuration

The FeedbackKitConfig class accepts the following options:

Environment

The Environment enum controls the target server:

Builder Pattern

You can configure FeedbackKit using the builder pattern or pass a config object directly:

// Option 1: Builder pattern with trailing lambda
FeedbackKit.configure(context, "your-api-key") {
    userId("user_12345")
    environment(Environment.PRODUCTION)
    timeout(60000L)
    debug(true)
}

// Option 2: Config object. FeedbackKitConfig has baseUrl, not environment.
val config = FeedbackKitConfig(
    apiKey = "your-api-key",
    userId = "user_12345",
    baseUrl = Environment.PRODUCTION.baseUrl,
    debug = true
)
FeedbackKit.configure(context, config)

// Access the shared singleton
val kit = FeedbackKit.shared

API Reference

All API methods are suspend functions designed for use with Kotlin coroutines. Access them via FeedbackKit.shared.

Feedback API

Access via FeedbackKit.shared.feedback:

// List all feedback
val feedbacks = FeedbackKit.shared.feedback.list()

// List with filters
val filtered = FeedbackKit.shared.feedback.list(
    ListFeedbackOptions(
        status = FeedbackStatus.APPROVED,
        category = FeedbackCategory.FEATURE_REQUEST
    )
)

// Get single feedback
val feedback = FeedbackKit.shared.feedback.get("feedback-id")

// Create feedback
val newFeedback = FeedbackKit.shared.feedback.create(
    CreateFeedbackRequest(
        title = "Add dark mode",
        description = "Would love dark mode support",
        category = FeedbackCategory.FEATURE_REQUEST
    )
)

Votes API

Access via FeedbackKit.shared.votes:

// Vote on feedback
val result = FeedbackKit.shared.votes.vote(
    feedbackId = "feedback-id",
    email = "user@example.com",
    notifyStatusChange = true
)

// Remove vote
val unvoteResult = FeedbackKit.shared.votes.unvote("feedback-id")

Comments API

Access via FeedbackKit.shared.comments:

// List comments
val comments = FeedbackKit.shared.comments.list("feedback-id")

// Add a comment
val comment = FeedbackKit.shared.comments.create(
    feedbackId = "feedback-id",
    request = CreateCommentRequest(
        content = "Great idea! We'll look into this.",
        userId = "user_12345"
    )
)

Users API

Access via FeedbackKit.shared.users:

// Register a user
val user = FeedbackKit.shared.users.register(
    userId = "user_12345",
    mrr = 9.99
)
FeedbackKit.shared.userId = user.userId

Events API

Access via FeedbackKit.shared.events:

// Track an event
val event = FeedbackKit.shared.events.track(
    name = "feedback_viewed",
    properties = mapOf(
        "screen" to "detail",
        "feedback_id" to "abc123"
    )
)
FeedbackKit.shared.events.track(PredefinedEventNames.FEEDBACK_LIST)

Composables

Pre-built Jetpack Compose UI components for common feedback patterns. All composables support Material 3 theming.

Usage Example

@Composable
fun FeedbackScreen() {
    var selectedFeedback by remember { mutableStateOf<Feedback?>(null) }
    var showSubmit by remember { mutableStateOf(false) }

    if (showSubmit) {
        SubmitFeedbackView(
            onSubmitSuccess = { feedback ->
                showSubmit = false
            },
            onBack = { showSubmit = false }
        )
    } else if (selectedFeedback != null) {
        FeedbackDetailView(
            feedback = selectedFeedback!!,
            onBack = { selectedFeedback = null }
        )
    } else {
        FeedbackList(
            onFeedbackClick = { feedback ->
                selectedFeedback = feedback
            }
        )
    }
}

Models

Core data classes used throughout the SDK.

Feedback

The primary model representing a feedback item.

Helper Methods

FeedbackStatus

Enum representing the lifecycle status of a feedback item.

Properties: canVote: Boolean, displayName: String, jsonValue: String

FeedbackCategory

Enum representing the type of feedback.

Properties: displayName: String, jsonValue: String

Comment

Represents a comment on a feedback item.

VoteResponse

Returned after voting or unvoting on a feedback item.

Other Models

Metrics

FeedbackKit.shared.metrics exposes summary, timeseries, breakdown, and events. The API key identifies the project. Pass days or dateFrom / dateTo. A window wider than the plan allows returns HTTP 200 with meta.retentionClamped. Read retentionWindowDays from the response. The documented windows are Free 30 days, Pro 90 days, and Team 365 days. Maven Central's published artifact is still 1.0.1, which does not include these calls. They are in this 1.2.x checkout.

val summary = FeedbackKit.shared.metrics.summary(
    MetricSummaryOptions(
        measures = listOf(MetricMeasure.FEEDBACK_COUNT, MetricMeasure.EVENT_COUNT),
        days = 7
    )
)

Error Handling

The SDK uses a sealed class hierarchy for type-safe error handling. All API errors extend FeedbackKitError.

Usage with Coroutines

Catch FeedbackKitError and switch on the subclass. Branch on e.code for a server token. The Free plan's 10-item feedback cap is not a 402: create succeeds and later lists omit the hidden rows. METRICS_CUSTOM_EVENTS_REQUIRE_PRO is the 402 for a breakdown by event name, a custom event-name filter, or the raw event feed. An archived project's writes are ForbiddenError.

import kotlinx.coroutines.*

fun loadFeedback() {
    viewModelScope.launch {
        try {
            val feedbacks = FeedbackKit.shared.feedback.list()
            // Update UI with feedbacks
        } catch (e: FeedbackKitError) {
            when (e) {
                is FeedbackKitError.AuthenticationError -> {
                    // Invalid API key
                    showError("Authentication failed")
                }
                is FeedbackKitError.PaymentRequiredError -> {
                    if (e.code == "METRICS_CUSTOM_EVENTS_REQUIRE_PRO") {
                        showUpgradePrompt()
                    }
                }
                is FeedbackKitError.RateLimitError -> {
                    showError("Too many requests")
                }
                is FeedbackKitError.NetworkError -> {
                    // No internet connection
                    showError("Check your connection")
                }
                is FeedbackKitError.ServerError -> {
                    // Server-side issue
                    showError("Server error: ${e.statusCode}")
                }
                else -> {
                    showError(e.message ?: "Unknown error")
                }
            }
        }
    }
}