Metadata API Developer Guide
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
IframeWhiteListUrlSettings
File Suffix and Directory Location
IframeWhiteListUrlSettings values are stored in the IframeWhiteListUrlSettings.settings file in the settings directory. The .settings files are different from other named components because there’s only one settings file for each settings component.
Version
IframeWhiteListUrlSettings components are available in API version 49.0 and later.
Fields
| Field Name | Field Type | Description |
|---|---|---|
| iframeWhiteListUrls | IframeWhiteListUrl[] | The list of external domains that you allow to frame your Visualforce pages or surveys. |
IframeWhiteListUrl
Represents the external domains that you allow to frame your Visualforce pages or surveys.
| Field Name | Field Type | Description |
|---|---|---|
| context | IFrameWhitelistContext (enumeration of type string) | Required. The type of content in the iframe. Valid values are:
|
| url | string | The unique domain that is allowed to frame your Visualforce pages, surveys, or Disclosure and Compliance Hub Connector. Accepts these formats: example.com, *example.com, and https://example.com. |
Declarative Metadata Sample Definition
The following is an example of a IframeWhiteListUrlSettings component.
<?xml version="1.0" encoding="UTF-8"?>
<IframeWhiteListUrlSettings xmlns="http://soap.sforce.com/2006/04/metadata">
<iframeWhiteListUrl>
<context>Surveys></context>
<url>example1.com</url>
</iframeWhiteListUrl>
<iframeWhiteListUrl>
<context>VisualforcePages</context>
<url>example2.com</url>
</iframeWhiteListUrl>
<iframeWhiteListUrl>
<context>DisclosureAndComplianceHubConnector</context>
<url>example3.com</url>
</iframeWhiteListUrl>
</IframeWhiteListUrlSettings>The following is an example package.xml that references the previous definition.
<?xml version="1.0" encoding="UTF-8"?>
<Package xmlns="http://soap.sforce.com/2006/04/metadata">
<types>
<members>IframeWhiteListUrlSettings</members>
<name>IframeWhiteListUrlSettings</name>
</types>
<version>62.0</version>
</Package>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.