# SettingsScriptApi

abstract class SettingsScriptApi(val delegate: ERROR CLASS: Symbol not found for Settings) : SettingsDelegate(source)

### Deprecated

Kept for compatibility with precompiled script plugins published with Gradle versions prior to 6.0

#### Replace with

    import org.gradle.api.initialization.Settings

Content copied to clipboard

    Settings

Content copied to clipboard

Standard implementation of the API exposed to all types of Settings scripts, precompiled and otherwise.

#### Inheritors

KotlinSettingsScript

## Constructors

SettingsScriptApi
Link copied to clipboard
constructor(delegate: ERROR CLASS: Symbol not found for Settings)

## Properties

delegate
Link copied to clipboard
open override val delegate: ERROR CLASS: Symbol not found for Settings
logger
Link copied to clipboard
val logger: ERROR CLASS: Symbol not found for Logger

Logger for settings. You can use this in your settings file to write log messages.

logging
Link copied to clipboard
val logging: ERROR CLASS: Symbol not found for ConfigurableFileCollection

The LoggingManager which can be used to receive logging and to control the standard output/error capture for this script. By default, `System.out` is redirected to the Gradle logging system at the `QUIET` log level, and `System.err` is redirected at the `ERROR` log level.

resources
Link copied to clipboard
val resources: ERROR CLASS: Symbol not found for ResourceHandler

Provides access to resource-specific utility methods, for example factory methods that create various resources.

## Functions

apply
Link copied to clipboard
open fun apply(action: org/gradle/api/Action<in org/gradle/api/plugins/ObjectConfigurationAction>)
open fun apply(closure: Closure<Any>)
open fun apply(options: Map<String, *>)
buildCache
Link copied to clipboard
open fun buildCache(action: org/gradle/api/Action<in org/gradle/caching/configuration/BuildCacheConfiguration>)
buildscript
Link copied to clipboard
open fun buildscript(block: ScriptHandlerScope.() -> Unit)

Configures the build script classpath for settings.

caches
Link copied to clipboard
open fun caches(cacheConfigurations: org/gradle/api/Action<in org/gradle/api/cache/CacheConfigurations>)
copy
Link copied to clipboard
fun copy(configuration: ERROR CLASS: Symbol not found for CopySpec.() -> Unit): ERROR CLASS: Symbol not found for WorkResult

Copies the specified files.

copySpec
Link copied to clipboard
fun copySpec(): ERROR CLASS: Symbol not found for CopySpec
fun copySpec(configuration: ERROR CLASS: Symbol not found for CopySpec.() -> Unit): ERROR CLASS: Symbol not found for CopySpec

Creates a {@link CopySpec} which can later be used to copy files or create an archive.

defaults
Link copied to clipboard
open fun defaults(action: org/gradle/api/Action<in org/gradle/api/initialization/SharedModelDefaults>)
delete
Link copied to clipboard
fun delete(configuration: ERROR CLASS: Symbol not found for DeleteSpec.() -> Unit): ERROR CLASS: Symbol not found for WorkResult

Deletes the specified files.

fun delete(vararg paths: Any): Boolean

Deletes files and directories.

dependencyResolutionManagement
Link copied to clipboard
open fun dependencyResolutionManagement(dependencyResolutionConfiguration: org/gradle/api/Action<in org/gradle/api/initialization/resolve/DependencyResolutionManagement>)
enableFeaturePreview
Link copied to clipboard
open fun enableFeaturePreview(name: String)
file
Link copied to clipboard
fun file(path: Any): File
fun file(path: Any, validation: ERROR CLASS: Symbol not found for PathValidation): File

Resolves a file path relative to this script's target base directory.

files
Link copied to clipboard
fun files(vararg paths: Any): ERROR CLASS: Symbol not found for ConfigurableFileCollection
fun files(paths: Any, configuration: ERROR CLASS: Symbol not found for ConfigurableFileCollection.() -> Unit): ERROR CLASS: Symbol not found for ConfigurableFileCollection

Creates a ConfigurableFileCollection containing the given files.

fileTree
Link copied to clipboard
fun fileTree(baseDir: Any): ERROR CLASS: Symbol not found for ConfigurableFileTree
fun fileTree(baseDir: Any, configuration: ERROR CLASS: Symbol not found for ConfigurableFileTree.() -> Unit): ERROR CLASS: Symbol not found for ConfigurableFileTree

Creates a new ConfigurableFileTree using the given base directory.

findProject
Link copied to clipboard
open fun findProject(projectDir: File): org/gradle/api/initialization/ProjectDescriptor??
open fun findProject(path: String): org/gradle/api/initialization/ProjectDescriptor??
getBuildCache
Link copied to clipboard
open fun getBuildCache(): org/gradle/caching/configuration/BuildCacheConfiguration
getBuildscript
Link copied to clipboard
open fun getBuildscript(): org/gradle/api/initialization/dsl/ScriptHandler
getCaches
Link copied to clipboard
open fun getCaches(): org/gradle/api/cache/CacheConfigurations
getDefaults
Link copied to clipboard
open fun getDefaults(): org/gradle/api/initialization/SharedModelDefaults
getDependencyResolutionManagement
Link copied to clipboard
open fun getDependencyResolutionManagement(): org/gradle/api/initialization/resolve/DependencyResolutionManagement
getExtensions
Link copied to clipboard
open fun getExtensions(): org/gradle/api/plugins/ExtensionContainer
getGradle
Link copied to clipboard
open fun getGradle(): org/gradle/api/invocation/Gradle
getLayout
Link copied to clipboard
open fun getLayout(): org/gradle/api/file/BuildLayout
getPluginManagement
Link copied to clipboard
open fun getPluginManagement(): org/gradle/plugin/management/PluginManagementSpec
getPluginManager
Link copied to clipboard
open fun getPluginManager(): org/gradle/api/plugins/PluginManager
getPlugins
Link copied to clipboard
open fun getPlugins(): org/gradle/api/plugins/PluginContainer
getProviders
Link copied to clipboard
open fun getProviders(): org/gradle/api/provider/ProviderFactory
getRootDir
Link copied to clipboard
open fun getRootDir(): File
getRootProject
Link copied to clipboard
open fun getRootProject(): org/gradle/api/initialization/ProjectDescriptor
getSettings
Link copied to clipboard
open fun getSettings(): org/gradle/api/initialization/Settings
getSettingsDir
Link copied to clipboard
open fun getSettingsDir(): File
getSourceControl
Link copied to clipboard
open fun getSourceControl(): org/gradle/vcs/SourceControl
getStartParameter
Link copied to clipboard
open fun getStartParameter(): org/gradle/StartParameter
getToolchainManagement
Link copied to clipboard
open fun getToolchainManagement(): org/gradle/api/toolchain/management/ToolchainManagement
include
Link copied to clipboard
open fun include(projectPaths: Iterable<String>)
includeBuild
Link copied to clipboard
open fun includeBuild(rootProject: Any)
open fun includeBuild(rootProject: Any, configuration: org/gradle/api/Action<org/gradle/api/initialization/ConfigurableIncludedBuild>)
includeFlat
Link copied to clipboard
open fun includeFlat(projectNames: Iterable<String>)
open fun includeFlat(vararg projectNames: String)
mkdir
Link copied to clipboard
fun mkdir(path: Any): File

Creates a directory and returns a file pointing to it.

pluginManagement
Link copied to clipboard
open fun pluginManagement(block: ERROR CLASS: Symbol not found for PluginManagementSpec.() -> Unit)

Configures the plugin management for the entire build.

open fun pluginManagement(pluginManagementSpec: org/gradle/api/Action<in org/gradle/plugin/management/PluginManagementSpec>)
project
Link copied to clipboard
open fun project(projectDir: File): org/gradle/api/initialization/ProjectDescriptor
open fun project(path: String): org/gradle/api/initialization/ProjectDescriptor
relativePath
Link copied to clipboard
fun relativePath(path: Any): String

Returns the relative path from this script's target base directory to the given path.

sourceControl
Link copied to clipboard
open fun sourceControl(configuration: org/gradle/api/Action<in org/gradle/vcs/SourceControl>)
tarTree
Link copied to clipboard
fun tarTree(tarPath: Any): ERROR CLASS: Symbol not found for FileTree

Creates a new FileTree which contains the contents of the given TAR file.

toolchainManagement
Link copied to clipboard
open fun toolchainManagement(toolchainManagementConfiguration: org/gradle/api/Action<in org/gradle/api/toolchain/management/ToolchainManagement>)
uri
Link copied to clipboard
fun uri(path: Any): URI

Resolves a file path to a URI, relative to this script's target base directory.

zipTree
Link copied to clipboard
fun zipTree(zipPath: Any): ERROR CLASS: Symbol not found for FileTree

Creates a new FileTree which contains the contents of the given ZIP file.