GenerateBuildConfigTask

@CacheableTask
abstract class GenerateBuildConfigTask : DefaultTask

Generate the runtime build-config object (generateBuildConfigSource) into a plugin-owned generated commonMain dir wired onto the shared module's source set. It never writes into the user's hand-authored tree. The task is cache-capable, but cache storage is denied unless the DSL explicitly enables it. A checksum ownership manifest removes only outputs from the previous successful generation. Unknown, modified, escaping, or symlinked content fails closed instead of being deleted.

Constructors

Link copied to clipboard
constructor()

Properties

Link copied to clipboard
@get:Input
abstract val allowBuildCache: Property<Boolean>
Link copied to clipboard
@get:Internal
abstract val androidApplicationId: Property<String>
Link copied to clipboard
@get:Internal
abstract val appName: Property<String>
Link copied to clipboard
@get:Input
abstract val className: Property<String>
Link copied to clipboard
@get:Input
abstract val customFields: ListProperty<String>
Link copied to clipboard
var description: @Nullable String
Link copied to clipboard
@get:Internal
abstract val dryRun: Property<Boolean>

Build-owned code generation always runs; global preview mode only applies to source rewrites.

Link copied to clipboard
@get:Internal
var enabled: Boolean
Link copied to clipboard
@get:Internal
abstract val generatedRoot: DirectoryProperty
Link copied to clipboard
var group: @Nullable String
Link copied to clipboard
Link copied to clipboard
@get:Input
abstract val identityInputs: ListProperty<String>

Effective identity fingerprint; empty when includeIdentity is false.

Link copied to clipboard
Link copied to clipboard
@get:Input
abstract val includeIdentity: Property<Boolean>
Link copied to clipboard
@get:Internal
abstract val iosBundleId: Property<String>
Link copied to clipboard
@get:Internal
abstract val locales: ListProperty<String>
Link copied to clipboard
@get:OutputDirectory
abstract val outputDir: DirectoryProperty
Link copied to clipboard
@get:Input
abstract val packageName: Property<String>
Link copied to clipboard
val state: TaskStateInternal
Link copied to clipboard
val timeout: Property<Duration>
Link copied to clipboard
@get:Internal
abstract val versionCode: Property<Int>
Link copied to clipboard
@get:Internal
abstract val versionName: Property<String>

Functions

Link copied to clipboard
open override fun acceptServiceReferences(serviceReferences: MutableSet<ServiceReferenceSpec>)
Link copied to clipboard
open override fun appendParallelSafeAction(action: Action<in Task>)
Link copied to clipboard
open operator override fun compareTo(other: Task): Int
Link copied to clipboard
open override fun configure(closure: Closure<Any>): Task
Link copied to clipboard
open override fun dependsOn(vararg paths: Any): Task
Link copied to clipboard
open override fun doFirst(action: Closure<Any>): Task
open override fun doFirst(action: Action<in Task>): Task
open override fun doFirst(actionName: String, action: Action<in Task>): Task
Link copied to clipboard
open override fun doLast(action: Closure<Any>): Task
open override fun doLast(action: Action<in Task>): Task
open override fun doLast(actionName: String, action: Action<in Task>): Task
Link copied to clipboard
open override fun doNotTrackState(reasonNotToTrackState: String)
Link copied to clipboard
open override fun doNotTrackStateIf(reason: String, spec: Spec<in TaskInternal>)
Link copied to clipboard
open override fun finalizedBy(vararg paths: Any): Task
Link copied to clipboard
fun generate()
Link copied to clipboard
open override fun getActions(): MutableList<Action<in Task>>
Link copied to clipboard
open override fun getAnt(): AntBuilder
Link copied to clipboard
@Internal
open override fun getAsDynamicObject(): DynamicObject
Link copied to clipboard
open override fun getDependsOn(): MutableSet<Any>
Link copied to clipboard
open override fun getDestroyables(): TaskDestroyables
Link copied to clipboard
open override fun getDidWork(): Boolean
Link copied to clipboard
open override fun getExtensions(): ExtensionContainer
Link copied to clipboard
open override fun getFinalizedBy(): TaskDependency
Link copied to clipboard
open override fun getIdentityPath(): Path
Link copied to clipboard
open override fun getInputs(): TaskInputsInternal
Link copied to clipboard
@Internal
open override fun getLifecycleDependencies(): TaskDependencyInternal
Link copied to clipboard
open override fun getLocalState(): TaskLocalState
Link copied to clipboard
open override fun getLogger(): Logger
Link copied to clipboard
open override fun getLogging(): LoggingManager
Link copied to clipboard
open override fun getMustRunAfter(): TaskDependency
Link copied to clipboard
open override fun getName(): String
Link copied to clipboard
open override fun getOnlyIf(): Spec<in TaskInternal>
Link copied to clipboard
open override fun getOutputs(): TaskOutputsInternal
Link copied to clipboard
open override fun getPath(): String
Link copied to clipboard
open override fun getProject(): Project
Link copied to clipboard
Link copied to clipboard
Link copied to clipboard
open override fun getRequiredServices(): TaskRequiredServices
Link copied to clipboard
open override fun getSharedResources(): MutableList<ResourceLock>
Link copied to clipboard
open override fun getShouldRunAfter(): TaskDependency
Link copied to clipboard
open override fun getStandardOutputCapture(): StandardOutputCapture
Link copied to clipboard
open override fun getTaskActions(): MutableList<InputChangesAwareTaskAction>
Link copied to clipboard
open override fun getTaskDependencies(): TaskDependencyInternal
Link copied to clipboard
open override fun getTaskIdentity(): TaskIdentity<*>
Link copied to clipboard
open override fun getTemporaryDir(): File
Link copied to clipboard
open override fun getTemporaryDirFactory(): Factory<File>
Link copied to clipboard
open override fun hasProperty(propertyName: String): Boolean
Link copied to clipboard
open override fun hasTaskActions(): Boolean
Link copied to clipboard
Link copied to clipboard
open override fun mustRunAfter(vararg paths: Any): Task
Link copied to clipboard
open override fun notCompatibleWithConfigurationCache(reason: String)
Link copied to clipboard
open override fun onlyIf(onlyIfClosure: Closure<Any>)
open override fun onlyIf(spec: Spec<in Task>)
open override fun onlyIf(onlyIfReason: String, spec: Spec<in Task>)
Link copied to clipboard
open override fun prependParallelSafeAction(action: Action<in Task>)
Link copied to clipboard
open override fun property(propertyName: String): Any
Link copied to clipboard
open override fun restoreOnlyIf(onlyIf: Spec<in TaskInternal>)
Link copied to clipboard
open override fun restoreTaskActions(taskActions: MutableList<InputChangesAwareTaskAction>)
Link copied to clipboard
open override fun setActions(replacements: MutableList<Action<in Task>>)
Link copied to clipboard
open override fun setDependsOn(dependsOn: MutableIterable<*>)
Link copied to clipboard
open override fun setDidWork(didWork: Boolean)
Link copied to clipboard
open override fun setFinalizedBy(finalizedByTasks: MutableIterable<*>)
Link copied to clipboard
open override fun setMustRunAfter(mustRunAfterTasks: MutableIterable<*>)
Link copied to clipboard
open override fun setOnlyIf(onlyIfClosure: Closure<Any>)
open override fun setOnlyIf(spec: Spec<in Task>)
open override fun setOnlyIf(onlyIfReason: String, spec: Spec<in Task>)
Link copied to clipboard
open override fun setProperty(name: String, value: Any)
Link copied to clipboard
open override fun setShouldRunAfter(shouldRunAfterTasks: MutableIterable<*>)
Link copied to clipboard
open override fun shouldRunAfter(vararg paths: Any): TaskDependency
Link copied to clipboard
open override fun usesService(service: Provider<out BuildService<*>>)