id.frak.sdk.core
| Name | Summary |
|---|---|
| DeepLinkHandling | enum DeepLinkHandling : Enum<DeepLinkHandling> How inbound links carrying an fCtx reach the SDK. |
| FrakConfig | class FrakConfig Everything the SDK needs to start, supplied once at id.frak.sdk.Frak.initialize. Never validated at construction; an unusable config surfaces later as FrakError.MerchantResolutionFailed. |
| FrakCurrency | enum FrakCurrency : Enum<FrakCurrency> Currency a reward is advertised in. Closed set: backend rejects anything else with a 422. |
| FrakEnvironment | sealed interface FrakEnvironment The Frak stage the SDK talks to. |
| FrakError | sealed class FrakError : Exception Every failure the SDK can hand back, as one closed hierarchy. CancellationException is never wrapped into one of these, see frakCall. No default arguments anywhere: a sealed class’s constructor is published, so a default would freeze a synthetic bridge into the .api dump. |
| FrakLanguage | enum FrakLanguage : Enum<FrakLanguage> Language for merchant-configured copy. Only en/fr exist today. |
| FrakLogLevel | enum FrakLogLevel : Enum<FrakLogLevel> Logcat verbosity. Default NONE. Also gates FrakConfig.logSink volume, see FrakLogSink. |
| FrakLogSink | fun interface FrakLogSink Receives SDK diagnostics, gated by FrakConfig.logLevel. Replaces logcat once set. |
| FrakMetadata | class FrakMetadata Static merchant-supplied facts, fixed at build time. Not the resolved backend config, see id.frak.sdk.config.FrakResolvedConfig. |
| FrakResult | sealed interface FrakResult<out T> Outcome of a fire-and-forget call. Not kotlin.Result: merchants need the typed FrakError arm. |
| ProductDetails | class ProductDetails The purchase line item fields a campaign’s productScope can target. Build with Builder, or ProductDetails { } from Kotlin. Also returned by the SDK, on id.frak.sdk.rewards.BestReward.matchedProducts, hence equals/hashCode. |
Functions
Section titled “Functions”| Name | Summary |
|---|---|
| FrakConfig | fun FrakConfig(configure: FrakConfig.Builder.() -> Unit): FrakConfig Kotlin sugar over FrakConfig.Builder for the no-merchant-id form. fun FrakConfig(merchantId: String): FrakConfig Merchant id only: the shortest working config. fun FrakConfig(merchantId: String, configure: FrakConfig.Builder.() -> Unit): FrakConfig Kotlin sugar over FrakConfig.Builder, for the merchant-id form. |
| FrakMetadata | fun FrakMetadata(configure: FrakMetadata.Builder.() -> Unit): FrakMetadata Kotlin sugar over FrakMetadata.Builder. |
| ProductDetails | fun ProductDetails(configure: ProductDetails.Builder.() -> Unit): ProductDetails Kotlin sugar over ProductDetails.Builder. |