API Documentation: XcodeIdeWorkspaceExtension

The configuration for mapping a Gradle project to Xcode projects and workspace.

The workspace extension is register to the Project instance only for the root project where the Xcode IDE plugin is applied. The project extension, that is XcodeIdeProjectExtension, is register to sub-projects instead.

Properties

Property Description

productTypes

Returns a repository containing all the known product types by the plugin. This method is provided as a convenience when configuring the Xcode project via the DSL.

It is equivalent to importing the class and accessing the public field:

projects

The projects to generate for this Gradle project.

workspace

The generated Xcode workspace for this Gradle build.

Methods

Method Description

projects(action)

Configures the project container with the specified action.

Property Details

XcodeIdeProductTypes productTypes (read-only)

Returns a repository containing all the known product types by the plugin. This method is provided as a convenience when configuring the Xcode project via the DSL.

It is equivalent to importing the XcodeIdeProductTypes class and accessing the public field:

plugins {
    id 'dev.nokee.xcode-ide'
}

import dev.nokee.ide.xcode.XcodeIdeProductTypes

xcode {
    projects.register('foo') {
        targets.register('Foo') {
            productType = XcodeIdeProductTypes.APPLICATION
        }
    }
}

NamedDomainObjectContainer<XcodeIdeProject> projects (read-only)

The projects to generate for this Gradle project.

XcodeIdeWorkspace workspace (read-only)

The generated Xcode workspace for this Gradle build.

Method Details

void projects(Action<? super NamedDomainObjectContainer<XcodeIdeProject>> action)

Configures the project container with the specified action.