mirror of
https://github.com/forcedotcom/afv-library.git
synced 2026-08-05 14:54:50 +08:00
44 lines
4.3 KiB
JSON
44 lines
4.3 KiB
JSON
{
|
|
"sections": [
|
|
"title",
|
|
"description",
|
|
"supported_soap_calls",
|
|
"supported_rest_api_http_methods",
|
|
"fields",
|
|
"special_access_rules",
|
|
"wsdl_segment"
|
|
],
|
|
"title": "EmbeddedServiceCustomComponent - Tooling API",
|
|
"description": "Represents a custom component created for an Embedded Service feature. The custom components can be an Aura or Lightning Web Component. This object is available in API version 44.0 and later.",
|
|
"supported_soap_calls": "`create()`, `delete()`, `describeSObjects()`, `query()`, `retrieve()`, `update()`, `upsert()`",
|
|
"supported_rest_api_http_methods": "`DELETE`, `GET`, `HEAD`, `PATCH`, `POST`, `Query`",
|
|
"fields_columns": [
|
|
"type",
|
|
"properties",
|
|
"description"
|
|
],
|
|
"fields": {
|
|
"CustomComponentId": {
|
|
"type": "reference",
|
|
"properties": "Create, Filter, Group, Sort, Update",
|
|
"description": "The unique ID of the LightningComponentBundle or AuraDefinitionBundle component to be used in the Embedded Service."
|
|
},
|
|
"CustomComponentType": {
|
|
"type": "picklist",
|
|
"properties": "Create, Filter, Group, Restricted picklist, Sort, Update",
|
|
"description": "The embedded component type associated with the chosen Feature that you want to customize. The possible values are: LA_ChatHeader—Not supported for AuraDefinitionBundle components LA_Minimized LA_PlainTextChatMessage—Not supported for AuraDefinitionBundle components LA_Prechat"
|
|
},
|
|
"EmbeddedServiceConfigId": {
|
|
"type": "reference",
|
|
"properties": "Create, Filter, Group, Sort",
|
|
"description": "The unique ID of the EmbeddedServiceConfig object that this custom component is associated with."
|
|
},
|
|
"Feature": {
|
|
"type": "picklist",
|
|
"properties": "Filter, Group, Nillable, Restricted picklist, Sort",
|
|
"description": "The Embedded Service feature that uses the custom component. The possible values are: Base ChannelMenu FieldService Flows LiveAgent NotInUse"
|
|
}
|
|
},
|
|
"special_access_rules": "This type is available only if Salesforce Experiences and Salesforce Sites are enabled in your org. To access this type, you need the Customize Application user permission.",
|
|
"wsdl_segment": "```xml\n<xsd:complexType name=\"EmbeddedServiceCustomComponent\">\n <xsd:complexContent>\n <xsd:extension base=\"ens:sObject\">\n <xsd:sequence>\n <xsd:element name=\"CreatedBy\" minOccurs=\"0\" type=\"ens:User\" nillable=\"true\"/>\n <xsd:element name=\"CreatedById\" minOccurs=\"0\" type=\"tns:ID\" nillable=\"true\"/>\n <xsd:element name=\"CreatedDate\" minOccurs=\"0\" type=\"xsd:dateTime\" nillable=\"true\"/>\n <xsd:element name=\"CustomComponent\" minOccurs=\"0\" type=\"ens:sObject\" nillable=\"true\"/>\n <xsd:element name=\"CustomComponentId\" minOccurs=\"0\" type=\"tns:ID\" nillable=\"true\"/>\n <xsd:element name=\"CustomComponentType\" minOccurs=\"0\" type=\"xsd:string\" nillable=\"true\"/>\n <xsd:element name=\"EmbeddedServiceConfig\" minOccurs=\"0\" type=\"ens:EmbeddedServiceConfig\" nillable=\"true\"/>\n <xsd:element name=\"EmbeddedServiceConfigId\" minOccurs=\"0\" type=\"tns:ID\" nillable=\"true\"/>\n <xsd:element name=\"Feature\" minOccurs=\"0\" type=\"xsd:string\" nillable=\"true\"/>\n <xsd:element name=\"IsDeleted\" minOccurs=\"0\" type=\"xsd:boolean\" nillable=\"true\"/>\n <xsd:element name=\"LastModifiedBy\" minOccurs=\"0\" type=\"ens:User\" nillable=\"true\"/>\n <xsd:element name=\"LastModifiedById\" minOccurs=\"0\" type=\"tns:ID\" nillable=\"true\"/>\n <xsd:element name=\"LastModifiedDate\" minOccurs=\"0\" type=\"xsd:dateTime\" nillable=\"true\"/>\n <xsd:element name=\"SystemModstamp\" minOccurs=\"0\" type=\"xsd:dateTime\" nillable=\"true\"/>\n </xsd:sequence>\n </xsd:extension>\n </xsd:complexContent>\n</xsd:complexType>\n<xsd:simpleType name=\"EmbeddedServiceCustomComponentType\">\n <xsd:restriction base=\"xsd:string\">\n <xsd:enumeration value=\"LA_Prechat\"/>\n <xsd:enumeration value=\"LA_Minimized\"/>\n <xsd:enumeration value=\"LA_PlainTextChatMessage\"/>\n <xsd:enumeration value=\"LA_ChatHeader\"/>\n <xsd:enumeration value=\"MIAW_Prechat\"/>\n <xsd:enumeration value=\"MIAW_Header\"/>\n <xsd:enumeration value=\"MIAW_TextMessage\"/>\n </xsd:restriction>\n</xsd:simpleType>\n```"
|
|
} |