Show / Hide Table of Contents

Class XCodeProject

The main enter point for the XCode project setup.

Inheritance
System.Object
XCodeProject
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ToString()
System.Object.ReferenceEquals(System.Object, System.Object)
Namespace: StansAssets.IOS.XCode
Assembly: cs.temp.dll.dll
Syntax
public static class XCodeProject

Properties

Capability

Capability Settings.

Declaration
public static XCodeCapabilitySettings Capability { get; }
Property Value
Type Description
XCodeCapabilitySettings

Settings

Project Settings.

Declaration
public static XCodeProjectSettings Settings { get; }
Property Value
Type Description
XCodeProjectSettings

Methods

AddFile(Object, String)

Adds asset copy step.

Declaration
public static void AddFile(Object asset, string xCodePath = "")
Parameters
Type Name Description
Object asset

A reference to the asset that will be copied.

System.String xCodePath

The Xcode project related path of where to copy the file. Will copy in the project root by default.

AddFile(XCodeAsset)

Adds asset copy step.

Declaration
public static void AddFile(XCodeAsset asset)
Parameters
Type Name Description
XCodeAsset asset

Asset model to copy.

AddFlag(String, XCodeFlagType)

Adds compiler or linker flag to the build configuration

Declaration
public static void AddFlag(string name, XCodeFlagType type)
Parameters
Type Name Description
System.String name

flag name.

XCodeFlagType type

flag type.

AddFramework(XCodeFramework)

Adds a system framework dependency.

The function assumes system frameworks are located in System/Library/Frameworks folder in the SDK source tree. The framework is added to Frameworks logical folder in the project.

Declaration
public static void AddFramework(XCodeFramework framework)
Parameters
Type Name Description
XCodeFramework framework

framework configuration object

AddFramework(XCodeFrameworkName, Boolean)

Adds a system framework dependency.

The function assumes system frameworks are located in System/Library/Frameworks folder in the SDK source tree. The framework is added to Frameworks logical folder in the project.

Declaration
public static void AddFramework(XCodeFrameworkName frameworkName, bool weak = false)
Parameters
Type Name Description
XCodeFrameworkName frameworkName

The name of the framework.

System.Boolean weak

True if the framework is optional (i.e. weakly linked), false if the framework is required.

AddLibrary(XCodeLibrary)

Adds a system library dependency.

The function assumes system library are located in System/Library/Frameworks folder in the SDK source tree. The library is added to Frameworks logical folder in the project.

Declaration
public static void AddLibrary(XCodeLibrary library)
Parameters
Type Name Description
XCodeLibrary library

library configuration object

AddLibrary(XCodeLibraryName, Boolean)

Adds a system library dependency.

The function assumes system library are located in System/Library/Frameworks folder in the SDK source tree. The library is added to Frameworks logical folder in the project.

Declaration
public static void AddLibrary(XCodeLibraryName libraryName, bool weak = false)
Parameters
Type Name Description
XCodeLibraryName libraryName

The name of the library.

System.Boolean weak

True if the framework is optional (i.e. weakly linked), false if the framework is required.

ContainsKey(String)

Returns true if this key already exists inside Info.plist

Declaration
public static bool ContainsKey(string name)
Parameters
Type Name Description
System.String name

Info.plist key name

Returns
Type Description
System.Boolean

GetInfoPlistKey(String)

Get's InfoPlistKey instance by it's name

Declaration
public static InfoPlistKey GetInfoPlistKey(string name)
Parameters
Type Name Description
System.String name

Info.plist key name

Returns
Type Description
InfoPlistKey

HasFile(Object)

Method that allow to check if certain asset was already added to the Xcode project.

Declaration
public static bool HasFile(Object asset)
Parameters
Type Name Description
Object asset

A reference to the asset.

Returns
Type Description
System.Boolean

Returns true if asset is added and false otherwise.

RemoveBuildProperty(XCodeProjectProperty)

Removes the build property.

Declaration
public static void RemoveBuildProperty(XCodeProjectProperty property)
Parameters
Type Name Description
XCodeProjectProperty property

Build property.

RemoveBuildProperty(String)

Removes the build property.

Declaration
public static void RemoveBuildProperty(string name)
Parameters
Type Name Description
System.String name

Property name.

RemoveFlag(String)

Removes the flag.

Declaration
public static void RemoveFlag(string name)
Parameters
Type Name Description
System.String name

Flag name.

RemoveFramework(XCodeFrameworkName)

Removes the framework.

Declaration
public static void RemoveFramework(XCodeFrameworkName frameworkName)
Parameters
Type Name Description
XCodeFrameworkName frameworkName

Framework type

RemoveInfoPlistKey(InfoPlistKey)

Removes Info.plist key

Declaration
public static void RemoveInfoPlistKey(InfoPlistKey key)
Parameters
Type Name Description
InfoPlistKey key

Info.plist key

RemoveInfoPlistKey(String)

Removes Info.plist key

Declaration
public static void RemoveInfoPlistKey(string name)
Parameters
Type Name Description
System.String name

Info.plist key name

RemoveLibrary(XCodeLibraryName)

Removes the library.

Declaration
public static void RemoveLibrary(XCodeLibraryName libraryName)
Parameters
Type Name Description
XCodeLibraryName libraryName

Library type.

SetBuildProperty(XCodeProjectProperty)

Sets a build property to the given value in all build configurations.

Declaration
public static void SetBuildProperty(XCodeProjectProperty property)
Parameters
Type Name Description
XCodeProjectProperty property

Property object instance.

SetBuildProperty(String, String)

Sets a build property to the given value in all build configurations.

Declaration
public static void SetBuildProperty(string name, string value)
Parameters
Type Name Description
System.String name

The name of the build property. Example: "ENABLE_BITCODE"

System.String value

The value of the build property. Example: "NO"

SetInfoPlistKey(InfoPlistKey)

Method will add or replace new InfoPlistKey to the Info.plist keys

Declaration
public static void SetInfoPlistKey(InfoPlistKey key)
Parameters
Type Name Description
InfoPlistKey key

Info.plist key name

In This Article
Back to top Generated by DocFX