javascript:titanium-package

Full name:

org.codehaus.mojo.javascript:javascript-maven-plugin:1.1-softec:titanium-package

Description:

Compile the titanium application based on the selected platform.

Attributes:

  • Requires a Maven project to be executed.
  • Binds by default to the lifecycle phase: package.

Required Parameters

Name Type Since Description
platform String -

The platform for which the code should be packaged.

Supported platforms are:

android
Package for the android platform.
iphone
Package for the iPhone platform.
ipad
Package for the iPad platform.
universal
Package for iPhone and iPad.
titaniumVersion String - The titanium SDK version to use.

Optional Parameters

Name Type Since Description
androidAPI String -

The version of the platform for which the code should be compiled.

This is the version of the library to use to compile the application. It's possible to specify another android API for the android virtual device. See VirtualDevice.androidAPI.
executeMode String -

The package execution mode.

Allow the execution of the package on an emulator/device.

Values are:

none
Do not execute. (Default value)
virtual
Execute on an emulator whose settings are specified in virtualDevice.
device
Execute on a connected device.

Default value is: none.
iosVersion String - The version of the platform for which the code should be compiled.
outputDirectory File - The output directory of the packaged titanium files.
Default value is: ${project.build.outputDirectory}.
titaniumSettings TitaniumSettings -

The titanium settings.

Contains various information needed to execute a titanium build.

Here's the list of the titaniumSettings parameters:

TitaniumSettings.androidBuilder
The titanium android builder.py file location. Optional. If not specified it tries to retrieve the builder based on titaniumVersion
TitaniumSettings.iosBuilder
The titanium iOS builder.py location. Optional. If not specified, it tries to retrieve the builder based on titaniumVersion
TitaniumSettings.androidSDK
The android SDK location. This parameter is optional, by default the android SDK is retrieved based on the environment variable ANDROID_HOME.
TitaniumSettings.keystore
The android keystore to use to sign the application. Optional. If not specified the Titanium keystore is used.
TitaniumSettings.keystorePassword
The android keystore password. Optional. If not specified the default titanium keystore password is used.
TitaniumSettings.keystoreAlias
The android keystore key alias. Optional. The alias of the key to use to sign the application. If not specified the default titanium alias is used.
TitaniumSettings.iosDevelopmentProvisioningProfile
The iOS development provisioning profile. This profile is use when executeMode is virtual or device.
TitaniumSettings.iosDistributionProvisioningProfile
The iOS distribution provisioning profile. This profile is used when executeMode is none.
TitaniumSettings.iosDevelopmentCertificate
The iOS development certificate. This certificate is used when executeMode is virtual or device.
TitaniumSettings.iosDistributionCertificate
The iOS distribution certificate. This certificate is used when executeMode is none.
virtualDevice VirtualDevice -

Virtual device configuration.

When executeMode is virtual, the parameters in virtualDevice are used to configure the android emulator or iphone simulator.

VirtualDevice has the following parameters:

VirtualDevice.androidAPI
The version on which the virtual device should run. If not specified, the latest android API version will be used. Regardless of the global androidAPI value.
VirtualDevice.iosVersion
The ios version of the virtual device. If not specified the latest available version will be used. Regardless of the global parameter value.
VirtualDevice.skin
The skin of the android emulator. Defaults to HVGA for version less than 10 and to WXGA for version greater than 10
VirtualDevice.family
The iOS device family. Valid values are iphone or ipad.
VirtualDevice.wait
How much miliseconds to wait after launching emulator before installing the android application.

Parameter Details

androidAPI:

The version of the platform for which the code should be compiled.

This is the version of the library to use to compile the application. It's possible to specify another android API for the android virtual device. See VirtualDevice.androidAPI.

  • Type: java.lang.String
  • Required: No
  • Expression: ${androidAPI}

executeMode:

The package execution mode.

Allow the execution of the package on an emulator/device.

Values are:

none
Do not execute. (Default value)
virtual
Execute on an emulator whose settings are specified in virtualDevice.
device
Execute on a connected device.
  • Type: java.lang.String
  • Required: No
  • Expression: ${executeMode}
  • Default: none

iosVersion:

The version of the platform for which the code should be compiled.
  • Type: java.lang.String
  • Required: No
  • Expression: ${iosVersion}

outputDirectory:

The output directory of the packaged titanium files.
  • Type: java.io.File
  • Required: No
  • Default: ${project.build.outputDirectory}

platform:

The platform for which the code should be packaged.

Supported platforms are:

android
Package for the android platform.
iphone
Package for the iPhone platform.
ipad
Package for the iPad platform.
universal
Package for iPhone and iPad.
  • Type: java.lang.String
  • Required: Yes
  • Expression: ${platform}

titaniumSettings:

The titanium settings.

Contains various information needed to execute a titanium build.

Here's the list of the titaniumSettings parameters:

TitaniumSettings.androidBuilder
The titanium android builder.py file location. Optional. If not specified it tries to retrieve the builder based on titaniumVersion
TitaniumSettings.iosBuilder
The titanium iOS builder.py location. Optional. If not specified, it tries to retrieve the builder based on titaniumVersion
TitaniumSettings.androidSDK
The android SDK location. This parameter is optional, by default the android SDK is retrieved based on the environment variable ANDROID_HOME.
TitaniumSettings.keystore
The android keystore to use to sign the application. Optional. If not specified the Titanium keystore is used.
TitaniumSettings.keystorePassword
The android keystore password. Optional. If not specified the default titanium keystore password is used.
TitaniumSettings.keystoreAlias
The android keystore key alias. Optional. The alias of the key to use to sign the application. If not specified the default titanium alias is used.
TitaniumSettings.iosDevelopmentProvisioningProfile
The iOS development provisioning profile. This profile is use when executeMode is virtual or device.
TitaniumSettings.iosDistributionProvisioningProfile
The iOS distribution provisioning profile. This profile is used when executeMode is none.
TitaniumSettings.iosDevelopmentCertificate
The iOS development certificate. This certificate is used when executeMode is virtual or device.
TitaniumSettings.iosDistributionCertificate
The iOS distribution certificate. This certificate is used when executeMode is none.
  • Type: org.codehaus.mojo.javascript.TitaniumSettings
  • Required: No

titaniumVersion:

The titanium SDK version to use.
  • Type: java.lang.String
  • Required: Yes
  • Expression: ${titaniumVersion}

virtualDevice:

Virtual device configuration.

When executeMode is virtual, the parameters in virtualDevice are used to configure the android emulator or iphone simulator.

VirtualDevice has the following parameters:

VirtualDevice.androidAPI
The version on which the virtual device should run. If not specified, the latest android API version will be used. Regardless of the global androidAPI value.
VirtualDevice.iosVersion
The ios version of the virtual device. If not specified the latest available version will be used. Regardless of the global parameter value.
VirtualDevice.skin
The skin of the android emulator. Defaults to HVGA for version less than 10 and to WXGA for version greater than 10
VirtualDevice.family
The iOS device family. Valid values are iphone or ipad.
VirtualDevice.wait
How much miliseconds to wait after launching emulator before installing the android application.
  • Type: org.codehaus.mojo.javascript.VirtualDevice
  • Required: No