kiosk-ops-sdk/com.sarastarquant.kioskops.sdk

Package-level declarations

Types

@RequiresOptIn(level = RequiresOptIn.Level.WARNING, message = "This KioskOps API is experimental and may change in future releases.")

@Target(allowedTargets = [AnnotationTarget.CLASS, AnnotationTarget.FUNCTION, AnnotationTarget.PROPERTY])

annotation class ExperimentalKioskOpsApi

Marks declarations that are experimental in KioskOps SDK.

HealthCheckResult

data class HealthCheckResult(val isInitialized: Boolean, val queueDepth: Long, val syncEnabled: Boolean, val lastHeartbeatReason: String?, val authProviderConfigured: Boolean, val encryptionEnabled: Boolean, val sdkVersion: String)

Structured health status of the SDK.

KioskOpsAlreadyInitializedException

class KioskOpsAlreadyInitializedException : KioskOpsException

Thrown when KioskOpsSdk.init is called more than once. Call KioskOpsSdk.get to access the existing instance.

KioskOpsConfig

data class KioskOpsConfig @JvmOverloads constructor(val baseUrl: String, val locationId: String, val kioskEnabled: Boolean, val syncIntervalMinutes: Long = 15, val adminExitPin: String? = null, val securityPolicy: SecurityPolicy = SecurityPolicy.maximalistDefaults(), val retentionPolicy: RetentionPolicy = RetentionPolicy.maximalistDefaults(), val telemetryPolicy: TelemetryPolicy = TelemetryPolicy.maximalistDefaults(), val queueLimits: QueueLimits = QueueLimits.maximalistDefaults(), val idempotencyConfig: IdempotencyConfig = IdempotencyConfig.maximalistDefaults(), val syncPolicy: SyncPolicy = SyncPolicy.disabledDefaults(), val transportSecurityPolicy: TransportSecurityPolicy = TransportSecurityPolicy(), val remoteConfigPolicy: RemoteConfigPolicy = RemoteConfigPolicy.disabledDefaults(), val diagnosticsSchedulePolicy: DiagnosticsSchedulePolicy = DiagnosticsSchedulePolicy.disabledDefaults(), val observabilityPolicy: ObservabilityPolicy = ObservabilityPolicy.disabledDefaults(), val geofencePolicy: GeofencePolicy = GeofencePolicy.disabledDefaults(), val policyProfiles: Map<String, PolicyProfile> = emptyMap(), val validationPolicy: ValidationPolicy = ValidationPolicy.disabledDefaults(), val piiPolicy: PiiPolicy = PiiPolicy.disabledDefaults(), val fieldEncryptionPolicy: FieldEncryptionPolicy = FieldEncryptionPolicy.disabledDefaults(), val dataClassificationPolicy: DataClassificationPolicy = DataClassificationPolicy.disabledDefaults(), val anomalyPolicy: AnomalyPolicy = AnomalyPolicy.disabledDefaults(), val databaseEncryptionPolicy: DatabaseEncryptionPolicy = DatabaseEncryptionPolicy.disabledDefaults(), val requireDataRightsAuthorization: Boolean = false)

Main configuration for KioskOps SDK.

KioskOpsError

sealed class KioskOpsError

Categorized SDK error reported to KioskOpsErrorListener.

KioskOpsErrorListener

fun interface KioskOpsErrorListener

Callback for non-fatal SDK operational errors.

KioskOpsException

open class KioskOpsException(message: String, cause: Throwable? = null) : RuntimeException

Base exception for KioskOps SDK errors.

KioskOpsInitializer

class KioskOpsInitializer : Initializer<Unit>

AndroidX Startup initializer.

KioskOpsNotInitializedException

class KioskOpsNotInitializedException : KioskOpsException

Thrown when KioskOpsSdk.get is called before KioskOpsSdk.init.

KioskOpsSdk

class KioskOpsSdk