Metadata API Developer Guide
jNewer Version Available
EmbeddedServiceConfig
Represents a setup node for creating an Embedded
Service for Web deployment.
This type extends the Metadata
metadata type and inherits its fullName field.
File Suffix and Directory Location
EmbeddedServiceConfig components are stored in the developer_name.EmbeddedServiceConfig file in the EmbeddedServiceConfig folder.
Version
EmbeddedServiceConfig is available in API version 37.0 and later.
Fields
| Field Name | Field Type | Description |
|---|---|---|
| areGuestUsersAllowed | boolean | Specifies whether a user must be logged in to access an embedded component. Available in API version 45.0 and later. |
| authMethod | EmbeddedServiceAuthMethod (enumeration of type string) | Type of login method selected for this Embedded Service deployment. One of the
following values:
|
| customMinimizedComponent | string | The custom Lightning component that’s used in this Embedded Service deployment in its minimized state. Available in API version 43.0 and later. |
| embeddedServiceCustomComponents | EmbeddedServiceCustomComponent[] | The custom components used in this Embedded Service deployment. Available in API version 44.0 and later. |
| embeddedServiceCustomLabels | EmbeddedServiceCustomLabel[] | The custom labels used in this Embedded Service deployment. Available in API version 44.0 and later. |
| embeddedServiceFlowConfig | EmbeddedServiceFlowConfig[] | Represents a setup node for creating an embedded flow. Available in API version 45.0 and later. |
| embeddedServiceFlows | EmbeddedServiceFlow[] | All of the flows used by this Embedded Service deployment. Available in API version 45.0 and later. |
| masterLabel | string | Required. The name of the Embedded Service configuration node. Available in API version 37.0 and later. |
| shouldHideAuthDialog | boolean | Specifies whether the prompt that the customer login again during a flow is hidden (true) or not (false). When it’s hidden, the customer is taken directly to your login page. This field is set to false by default. Available in API version 43.0 and later. |
| site | string | Required. The name of the Salesforce Community or site connected to this Embedded Service deployment. Available in API version 37.0 and later. |
EmbeddedServiceCustomComponent
Returns a custom component that’s associated with an EmbeddedServiceConfig setup.
| Field Name | Field Type | Description |
|---|---|---|
| customComponent | string | The name of the custom component. |
| customComponentType | EmbeddedServiceCustomComponent (enumeration of type string) | The type of custom component. One of the following values:
|
EmbeddedServiceCustomLabel
Returns a custom label that’s associated with an EmbeddedServiceConfig setup.
| Field Name | Field Type | Description |
|---|---|---|
| customLabel | string | The customized label that appears in the embedded component. |
| feature | EmbeddedServiceFeature (enumeration of type string) | The feature that this embedded component uses. One of the following values:
|
| labelKey | EmbeddedServiceLabelKey (enumeration of type string) | The type of label for this embedded component. The value corresponds to the label within a label group (substate of chat state or page type). |
EmbeddedServiceFlow
Returns an embedded flow that’s associated with an EmbeddedServiceConfig setup.
| Field Name | Field Type | Description |
|---|---|---|
| flow | string | The developer name of the flow. |
| flowType | EmbeddedServiceFlowType(enumeration of type string) | The type of flow. One of the following values:
|
| isAuthenticationRequired | boolean | Indicates whether users are required to log in to access the Embedded Service component. The value cannot be true for the FS_Flow value and must be true for all other values. |
EmbeddedServiceFlowConfig
Returns the EmbeddedServiceFlowConfig type.
| Field Name | Field Type | Description |
|---|---|---|
| enabled | boolean | Indicates whether the embedded flow is enabled. |
Declarative Metadata Sample Definition
The following is an example of an EmbeddedServiceConfig file.
1This is an example of an EmbeddedServiceConfig file.
2<?xml version="1.0" encoding="UTF-8"?>
3<EmbeddedServiceConfig xmlns="http://soap.sforce.com/2006/04/metadata">
4 <authMethod>CommunitiesLogin</authMethod>
5 <customMinimizedComponent>customMinimized</customMinimizedComponent>
6 <masterLabel>EswFS</masterLabel>
7 <shouldHideAuthDialog>false</shouldHideAuthDialog>
8 <site>SiteName</site>
9</EmbeddedServiceConfig>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.