Metadata API Developer Guide
jNewer Version Available
CustomAddressFieldSettings
Parent Type and Manifest Access
This type extends the Metadata metadata type and inherits its fullName field.
In the package manifest, all the settings metadata types for the org are accessed using the “Settings” name. See Settings for more details.
File Suffix and Directory Location
CustomAddressFieldSettings values are stored in the CustomAddressField.settings file in the settings folder. The .settings files are different from other named components, because there is only one settings file for each settings component.
Version
CustomAddressFieldSettings components are available in API version 55.0 and later.
Fields
| Field Name | Field Type | Description |
|---|---|---|
| enableCustomAddressField | boolean | Indicates whether the Address
Field Type is available
for custom fields (true) or not
(false). The default value
is false. Custom Address Fields can’t be disabled. When enableCustomAddressField is set to true, you can’t change the value to false. |
Declarative Metadata Sample Definition
The following is an example of a CustomAddressFieldSettings component.
1<?xml version="1.0" encoding="UTF-8"?>
2<CustomAddressFieldSettings xmlns="http://soap.sforce.com/2006/04/metadata">
3 <enableCustomAddressField>true</enableCustomAddressField>
4</CustomAddressFieldSettings>The following is an example package.xml that references the previous definition.
1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3 <types>
4 <members>CustomAddressField</members>
5 <name>Settings</name>
6 </types>
7 <version>55.0</version>
8</Package>Wildcard Support in the Manifest File
The wildcard character * (asterisk) in the package.xml manifest file doesn’t apply to metadata types for feature settings. The wildcard applies only when retrieving all settings, not for an individual setting. For details, see Settings. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.