Skip to content

retrieveAddressSettingsXml

retrieveAddressSettingsXml(options): Promise<string>

Defined in: packages/simply-settings-core/src/address/addressSettingsTransfer.ts:65

Retrieves the org’s Address settings (the AddressSettings metadata type, which holds every country and state in State and Country/Territory Picklists).

A Metadata API retrieve rather than a readMetadata call, because what comes back is then exactly the source-format file deployAddressSettingsXml sends back — one representation for both reading and writing, with no type coercion in between.

AddressSettingsTransferOptions

The org connection and how long to wait for the retrieve.

Promise<string>

The Address.settings-meta.xml file’s text.