Metadata API Developer Guide
jNewer Version Available
EmbeddedServiceFieldService
Represents a setup node for creating a
Snap-ins Appointment Management deployment.
This type extends the Metadata
metadata type and inherits its fullName field.
File Suffix and Directory Location
EmbeddedServiceFieldService components are stored in a developer_name.EmbeddedServiceFieldService file in the EmbeddedServiceFieldService folder.
Version
EmbeddedServiceLiveAgent is available in API version 43.0 and later.
Fields
| Field Name | Field Type | Description |
|---|---|---|
| appointmentBookingFlowName | string | Name of the appointment booking flow for this Snap-ins Appointment Management (beta) deployment. |
| cancelApptBookingFlowName | string | Name of the appointment cancellation flow for this Snap-ins Appointment Management (beta) deployment. |
| embeddedServiceConfig | string | Required. The name of the embedded service configuration node. |
| enabled | boolean | Required. Indicates whether this Snap-ins Appointment Management deployment is enabled (true). |
| fieldServiceConfirmCardImg | string | URL of the image used for the confirmation card in Snap-ins Appointment Management (beta). |
| fieldServiceHomeImg | string | URL of the image used for the home screen in Snap-ins Appointment Management (beta). |
| fieldServiceLogoImg | string | URL of the logo used for the home screen in Snap-ins Appointment Management (beta). |
| masterLabel | string | Required. Name of the Snap-ins Appointment Management (beta) deployment. |
| modifyApptBookingFlowName | string | Name of the appointment modification flow for this Snap-ins Appointment Management (beta) deployment. |
| shouldShowExistingAppointment | boolean | Specifies whether to display a button on the home screen for customers to access their existing appointments (true) or not (false). This field is false by default. |
| shouldShowNewAppointment | boolean | Specifies whether to display a button on the home screen for customers to create a new appointment (true) or not (false). This field is false by default. |
Declarative Metadata Sample Definition
The following is an example of an EmbeddedServiceFieldService file.