Log In | Not a Member?

Hide TOC

Choice

Technology area	Installer
Availability	Available in Mac OS X v10.4 and later.

Overview

A Choice object represents a single installation choice. Choice objects are properties of the choices global variable and represent the installation choices defined in a distribution package.

The name of each property of the choices array corresponds to the choice-id attribute of each of the distribution’s installation choices (see Distribution Definition Reference for more information). Therefore, a specific choice is accessed this way:

choices.<choice-id>

<choice-id> represents the identifier of the desired choice in the installation definition. For example, to access the selected property of a choice with 'choice_a' as its identifier, you would use the following expression:

choices.['choice_a'].selected

Properties

selected

true when the choice is selected, false otherwise.

Available in Mac OS X v10.4 and later.

enabled

true when the choice is enabled, false otherwise.

Available in Mac OS X v10.4 and later.

visible

true when the choice is visible, false otherwise.

Available in Mac OS X v10.4 and later.

title

String with the title of the distribution package.

Available in Mac OS X v10.4 and later.

description

String with the description of the distribution.

Available in Mac OS X v10.4 and later.

packages

Array identifying each package attached to the choice. Each item of the array references a pkg-ref element in the installation definition and contains the following two properties:

identifier: The package identifier. Corresponds to the id attribute of the pkg-ref element.
version: The package version. Corresponds to the version attribute of the pkg-ref element.

Available in Mac OS X v10.4 and later.

packageUgradeAction

String that specifies the relationship between the choice’s packages (specified by the packages property) and the same packages (based on the package identifier) installed on the host. The possible values are:

'clean': None of the packages are installed.
'installed': All the packages are already installed.
'upgrade': The versions of all the packages are higher than the versions of the installed packages.
'downgrade': The versions of all the packages are lower than the versions of the installed packages.
'mixed': At least two of the following conditions are true:
- One or more of the packages are upgrades.
- One or more of the packages are downgrades.
- One or more of the packages are not installed.

For example, if a distribution contains a choice with a required package, you may deselect that choice if the installed package is more recent.

Available in Mac OS X v10.4 and later.

Hide TOC

Last updated: 2007-07-23

Did this document help you?
Yes: Tell us what works for you. It’s good, but: Report typos, inaccuracies, and so forth. It wasn’t helpful: Tell us what would have helped.




	Get information on Apple products. Visit the Apple Store online or at retail locations. 1-800-MY-APPLE Copyright © 2007 Apple Inc. All rights reserved. \| Terms of use \| Privacy Notice