Metadata API Developer Guide
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
Package
| Name | Type | Description |
|---|---|---|
| apiAccessLevel | APIAccessLevel (enumeration of type string) | Package components have access via dynamic
Apex and the API to standard and custom objects in the organization where they’re
installed. Administrators who install packages can restrict this access after
installation for improved security. The valid values are:
For more information, see “API and Dynamic Apex Access in Packages” in Salesforce Help. |
| description | string | A short description of the package. |
| fullName | string | The package name used as a unique identifier for API access. The fullName can contain only underscores and alphanumeric characters. It must be unique, begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. This field is inherited from the Metadata component. |
| namespacePrefix | string | The namespace of the developer organization where the package was created. |
| objectPermissions | ProfileObjectPermissions[] | Indicates which objects are accessible to the package, and the kind of access available (create, read, update, delete). |
| packageType | string | Reserved for future use. |
| postInstallClass | string | The name of the Apex class that specifies the actions to execute after the
package has been installed or upgraded. The Apex class must be a member of the package
and must implement the Apex InstallHandler
interface. In patch upgrades, you can't change the class name in this field but you
can change the contents of the Apex class. The class name can be changed in major
upgrades. This field is available in API version 24.0 and later. |
| setupWeblink | string | The weblink used to describe package installation. |
| types | PackageTypeMembers[] | The type of component being retrieved. |
| uninstallClass | string | The name of the Apex class that specifies the actions to execute after the
package has been uninstalled. The Apex class must be a member of the package and must
implement the Apex UninstallHandler interface.
In patch upgrades, you can't change the class name in this field but you can change
the contents of the Apex class. The class name can be changed in major
upgrades. This field is available in API version 25.0 and later. |
| version | string | Required. The version of the component type. |
PackageTypeMembers
Use to specify the name and type of components to be retrieved in a package.
| Name | Type | Description |
|---|---|---|
| members | string |
One or more named components, or the wildcard character (*) to retrieve all metadata components of the type specified in the <name> element. To retrieve a standard object, specify it by name. For example, <members>Account</members> retrieves the standard Account object. |
| name | string |
The type of metadata component to be retrieved. For example, <name>CustomObject</name> retrieves one or more custom objects as specified in the <members> element. |
Wildcard Support in the Manifest File
This metadata type doesn’t support the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.