core/co.cafeyn.cgs.api/SdkConfig/Builder

Builder

class Builder(context: Context)

Builds an SdkConfig.

Parameters

context

any Context; only its application context is retained, so passing an Activity here leaks nothing.

Constructors

Link copied to clipboard
constructor(context: Context)

Functions

Link copied to clipboard
fun apiKey(apiKey: String): SdkConfig.Builder

The license key you were issued.

Link copied to clipboard
fun build(): SdkConfig

Freezes everything set so far into an SdkConfig.

Link copied to clipboard
fun coroutineContext(context: CoroutineContext): SdkConfig.Builder

The context the SDK launches the cleanup of a lost session in.

Link copied to clipboard
fun environment(environment: CgsEnvironment): SdkConfig.Builder

Which backend to talk to. Defaults to CgsEnvironment.PRODUCTION.

Link copied to clipboard
fun logger(logger: Logger): SdkConfig.Builder

Where the SDK's diagnostics go. Defaults to NoopLogger — nothing is logged unless you ask for it, except by the reader's rendering engine, which writes to Logcat on its own.

Link copied to clipboard
fun onSessionLost(onSessionLost: () -> Unit): SdkConfig.Builder

Called when the session is lost for good and cannot be refreshed — a revoked token, an account closed on your side.

Link copied to clipboard
fun productName(productName: String): SdkConfig.Builder

The product name issued to you alongside the license. It identifies which catalogue and which entitlements your app is served.

Link copied to clipboard
fun selectsProfileAutomatically(selectsProfileAutomatically: Boolean): SdkConfig.Builder

Lets the SDK choose the active profile, for a host that has no profiles of its own.