Note: This is the migration API reference for FAKE 5. The new (modularized) API documentation can be found here. If the API is already migrated you can check here if exists in a module. More information regarding the migration can be found here

Xamarin

Contains tasks for building Xamarin.iOS and Xamarin.Android apps

Nested types and modules

TypeDescription
AndroidAbiTarget
AndroidAbiTargetConfig
AndroidPackageAbiParam
AndroidPackageParams

The Android packaging parameter type
AndroidSignAndAlignParams
IncrementerVersion
XamarinComponentRestoreParams

The package restore paramater type
iOSArchiveParams

The iOS archive paramater type
iOSBuildParams

The iOS build paramater type

Functions and values

Function or valueDescription
AllAndroidAbiTargets
Signature: AndroidPackageAbiParam
AndroidBuildPackages(setParams)
Signature: setParams:(AndroidPackageParams -> AndroidPackageParams) -> FileInfo list

Packages a Xamarin.Android app, returning a multiple FileInfo objects for the unsigned APK files

Parameters

  • setParams - Function used to override the default build parameters
AndroidPackage(setParams)
Signature: setParams:(AndroidPackageParams -> AndroidPackageParams) -> FileInfo

Packages a Xamarin.Android app, returning a FileInfo object for the unsigned APK file

Parameters

  • setParams - Function used to override the default build parameters
AndroidPackageDefaults
Signature: AndroidPackageParams

The default Android packaging parameters
AndroidSignAndAlign setParams apkFile
Signature: setParams:(AndroidSignAndAlignParams -> AndroidSignAndAlignParams) -> apkFile:FileInfo -> FileInfo

Signs and aligns a Xamarin.Android package, returning a FileInfo object for the signed APK file

Parameters

  • setParams - Function used to override the default build parameters
  • apkFile - FileInfo object for an unsigned APK file to sign and align
AndroidSignAndAlignDefaults
Signature: AndroidSignAndAlignParams

The default Android signing and aligning parameters
AndroidSignAndAlignPackages(...)
Signature: setParams:(AndroidSignAndAlignParams -> AndroidSignAndAlignParams) -> apkFiles:seq<FileInfo> -> seq<FileInfo>

Signs and aligns multiple Xamarin.Android packages, returning multiple FileInfo objects for the signed APK file

Parameters

  • setParams - Function used to override the default build parameters
  • apkFiles - FileInfo object for an unsigned APK file to sign and align
iOSArchive(setParams)
Signature: setParams:(iOSArchiveParams -> iOSArchiveParams) -> unit

Archive a project using Xamarin's iOS archive tools

Parameters

  • setParams - Function used to override the default archive parameters
iOSArchiveDefaults
Signature: iOSArchiveParams

The default iOS archive parameters
iOSBuild(setParams)
Signature: setParams:(iOSBuildParams -> iOSBuildParams) -> unit

Builds a project or solution using Xamarin's iOS build tools

Parameters

  • setParams - Function used to override the default build parameters
iOSBuildDefaults
Signature: iOSBuildParams

The default iOS build parameters
RestoreComponents setParams projectFile
Signature: setParams:(XamarinComponentRestoreParams -> XamarinComponentRestoreParams) -> projectFile:string -> unit

Restores NuGet packages and Xamarin Components for a project or solution

Parameters

  • setParams - Function used to override the default package restore parameters
XamarinComponentRestoreDefaults
Signature: XamarinComponentRestoreParams

The default package restore parameters