api/io.devconsole.api/DevConsoleConfig

DevConsoleConfig

data class DevConsoleConfig(val eventBufferCapacity: Int = DEFAULT_EVENT_BUFFER_CAPACITY, val stateProviders: List<StateProvider> = emptyList(), val featureFlags: List<FeatureFlag> = emptyList(), val composerEnabled: Boolean = false, val composerAllowedHosts: Set<String> = emptySet(), val stateMutationsEnabled: Boolean = false, val redactionPolicy: RedactionPolicy = RedactionPolicy.default())

Host configuration supplied to io.devconsole.DevConsole.initialize.

Kotlin callers use named arguments; Java callers use DevConsoleConfig.builder, because Kotlin default arguments do not cross the language boundary and positional construction would break at every call site the moment a field is added.

State providers and flags supplied here are registered at initialize. Features that are constructed later can register themselves through io.devconsole.DevConsole.registerStateProvider.

Constructors

DevConsoleConfig

constructor(eventBufferCapacity: Int = DEFAULT_EVENT_BUFFER_CAPACITY, stateProviders: List<StateProvider> = emptyList(), featureFlags: List<FeatureFlag> = emptyList(), composerEnabled: Boolean = false, composerAllowedHosts: Set<String> = emptySet(), stateMutationsEnabled: Boolean = false, redactionPolicy: RedactionPolicy = RedactionPolicy.default())

Types

Builder

class Builder

Mutable builder for Java callers and for incremental construction.

Companion

object Companion

Properties

browserConfig

var browserConfig: BrowserConfig

captureCategories

var captureCategories: Set<CaptureCategory>

Which capture surfaces are enabled at all. Defaults to every category so existing hosts see no behaviour change. An empty set is legal -- it means "capture nothing" -- and is reported (never thrown) as ConfigValidationCode.NO_CAPTURE_CATEGORIES_ENABLED by validationErrors.

composerAllowedHosts

val composerAllowedHosts: Set<String>

Exact hosts the Composer may reach when composerEnabled. Empty denies every destination.

composerEnabled

val composerEnabled: Boolean

Enables the Composer, which lets an authenticated session make the device issue arbitrary outbound HTTP requests. Off by default because that turns the device into a proxy onto its network; pair with composerAllowedHosts to confine it to known backends.

crashPolicy

var crashPolicy: CrashPolicy

Uncaught-exception / ANR capture depth. See CrashPolicy for the enable gates and caps.

editingCapabilities

var editingCapabilities: EditingCapabilities

eventBufferCapacity

val eventBufferCapacity: Int

featureFlags

val featureFlags: List<FeatureFlag>

openTriggers

var openTriggers: OpenTriggers

Opt-in in-app ways to open the inspector UI. See OpenTriggers; everything defaults to off.

redactionPolicy

val redactionPolicy: RedactionPolicy

Redaction applied at every capture boundary and reported to the dashboard.

remoteConfigProviders

var remoteConfigProviders: List<RemoteConfigProvider>

Remote Config sources the inspector reads. Like stateProviders these are pull-based, so a provider constructed after initialize can still be added through io.devconsole.DevConsole.registerRemoteConfigProvider. Gated by CaptureCategory.STATE.

retentionPolicy

var retentionPolicy: RetentionPolicy

screenshotPolicy

var screenshotPolicy: ScreenshotPolicy

Foreground-window screenshot capture. See ScreenshotPolicy for why it is off by default.

sessionPolicy

var sessionPolicy: SessionPolicy

stateMutationsEnabled

val stateMutationsEnabled: Boolean

Enables dashboard-driven state mutations. Off by default; state stays read-only otherwise.

stateProviders

val stateProviders: List<StateProvider>

storagePolicy

var storagePolicy: StoragePolicy

Additive policy fields live outside the primary constructor to preserve the 1.x JVM ABI.

Functions

capturesCategory

fun capturesCategory(category: CaptureCategory): Boolean

runtimeEquivalentTo

fun runtimeEquivalentTo(other: DevConsoleConfig): Boolean

validationErrors

@JvmOverloads

fun validationErrors(isDebuggableRuntime: Boolean = true): List<ConfigValidationError>

Aggregates host mistakes without throwing into Application.onCreate. The enabled Android facade passes the real debuggable flag; standalone callers default to a debug-safe check.

withBrowserConfig