afv-library/skills/platform-metadata-api-context-get/assets/metadata_api/ChoiceList.json

66 lines
34 KiB
JSON
Raw Normal View History

{
"sections": [
"title",
"description",
"file_information",
"directory_location",
"fields",
"sub_types",
"wsdl_segment",
"declarative_metadata_sample_definition"
],
"title": "ChoiceList - Metadata API",
"description": "Represents the Choicelist dropdown field thats used for pre-chat.",
"file_information": ".ChoiceList",
"directory_location": "ChoiceList",
"fields_columns": [
"type",
"description",
"required"
],
"fields": {
"choiceListValue": {
"type": "ChoiceListValue[]",
"description": "A list of choices to display in the choice list."
},
"description": {
"type": "string",
"description": "A description of the choice list."
},
"masterLabel": {
"type": "string",
"required": true,
"description": "The label for the choice list."
}
},
"sub_types": {
"ChoiceListValue": {
"embeddedServiceCustomLabels": {
"type": "EmbeddedServiceCustomLabel[]",
"description": "Custom labels for the choicelist value."
},
"isDefaultValue": {
"type": "boolean",
"required": true,
"description": "Indicates whether the choicelist value should be selected by default."
},
"order": {
"type": "int",
"required": true,
"description": "The order of the choicelist value in the choicelist dropdown field."
},
"valueName": {
"type": "string",
"required": true,
"description": "The value of the choicelist."
}
}
},
"wsdl_segment": "```xml\n<xsd:complexType name=\"ChoiceList\">\n <xsd:complexContent>\n <xsd:extension base=\"tns:Metadata\">\n <xsd:sequence>\n <xsd:element name=\"choiceListValue\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:ChoiceListValue\"/>\n <xsd:element name=\"description\" minOccurs=\"0\" type=\"xsd:string\"/>\n <xsd:element name=\"masterLabel\" type=\"xsd:string\"/>\n </xsd:sequence>\n </xsd:extension>\n </xsd:complexContent>\n</xsd:complexType>\n<xsd:complexType name=\"ChoiceListValue\">\n <xsd:sequence>\n <xsd:element name=\"embeddedServiceCustomLabels\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:EmbeddedServiceCustomLabel\"/>\n <xsd:element name=\"isDefaultValue\" type=\"xsd:boolean\"/>\n <xsd:element name=\"order\" type=\"xsd:int\"/>\n <xsd:element name=\"valueName\" type=\"xsd:string\"/>\n </xsd:sequence>\n</xsd:complexType>\n<xsd:complexType name=\"EmbeddedServiceCustomLabel\">\n <xsd:sequence>\n <xsd:element name=\"customLabel\" minOccurs=\"0\" type=\"xsd:string\"/>\n <xsd:element name=\"feature\" minOccurs=\"0\" type=\"tns:EmbeddedServiceFeature\"/>\n <xsd:element name=\"labelKey\" minOccurs=\"0\" type=\"tns:EmbeddedServiceLabelKey\"/>\n </xsd:sequence>\n</xsd:complexType>\n<xsd:simpleType name=\"EmbeddedServiceFeature\">\n <xsd:restriction base=\"xsd:string\">\n <xsd:enumeration value=\"NotInUse\"/>\n <xsd:enumeration value=\"Base\"/>\n <xsd:enumeration value=\"LiveAgent\"/>\n <xsd:enumeration value=\"FieldService\"/>\n <xsd:enumeration value=\"Flows\"/>\n <xsd:enumeration value=\"ChannelMenu\"/>\n <xsd:enumeration value=\"EmbeddedMessaging\"/>\n </xsd:restriction>\n</xsd:simpleType>\n<xsd:simpleType name=\"EmbeddedServiceLabelKey\">\n <xsd:restriction base=\"xsd:string\">\n <xsd:enumeration value=\"LA_Container_Base_Close\"/>\n <xsd:enumeration value=\"LA_Container_Base_Minimize\"/>\n <xsd:enumeration value=\"LA_Container_Base_EndOfDialog\"/>\n <xsd:enumeration value=\"LA_Container_Base_MinimizedContainerAssistiveText\"/>\n <xsd:enumeration value=\"LA_Chat_Body_ChatWindowAgent\"/>\n <xsd:enumeration value=\"LA_Chat_Body_InputTextPlaceholder\"/>\n <xsd:enumeration value=\"LA_Chat_Body_AgentTypingUpdate\"/>\n <xsd:enumeration value=\"LA_Chat_Body_Send\"/>\n <xsd:enumeration value=\"LA_Chat_Body_ChatStartTime\"/>\n <xsd:enumeration value=\"LA_Chat_Body_MessageAreaTransferred\"/>\n <xsd:enumeration value=\"LA_Chat_Body_FileTransferCanceled\"/>\n <xsd:enumeration value=\"LA_Chat_Body_FileTransferSuccess\"/>\n <xsd:enumeration value=\"LA_Chat_Body_FileTransferFailure\"/>\n <xsd:enumeration value=\"LA_Chat_Body_FileTransferRequested\"/>\n <xsd:enumeration value=\"LA_Chat_Body_TransferFailed\"/>\n <xsd:enumeration value=\"LA_Chat_ExtendedHeader_ShowExtendedHeader\"/>\n <xsd:enumeration value=\"LA_Chat_ExtendedHeader_HideExtendedHeader\"/>\n <xsd:enumeration value=\"LA_Chat_ExtendedHeader_ChatStateHeaderGreeting\"/>\n <xsd:enumeration value=\"LA_Chat_ExtendedHeader_SaveTranscript\"/>\n <xsd:enumeration value=\"LA_Chat_ExtendedHeader_EndChatAction\"/>\n <xsd:enumeration value=\"LA_Chat_FileTransfer_FileUpload\"/>\n <xsd:enumeration value=\"LA_Chat_FileTransfer_UploadFile\"/>\n <xsd:enumeration value=\"LA_Chat_FileTransfer_SelectNewFile\"/>\n <xsd:enumeration value=\"LA_Chat_FileTransfer_UsePreviousElementToUploadFile\"/>\n <xsd:enumeration value=\"LA_Chat_FileTransfer_RemoveFile\"/>\n <xsd:enumeration value=\"LA_Chat_Minimized_MessageNotification\"/>\n <xsd:enumeration value=\"LA_Chat_Minimized_SingleMessageNotification\"/>\n <xsd:enumeration value=\"LA_Chat_Minimized_AgentSaysNotification\"/>\n <xsd:enumeration value=\"LA_Chat_Minimized_IdleTimeoutMinimizedWarning\"/>\n <xsd:enumeration value=\"LA_Chat_Minimized_IdleTimeoutMinimizedEndChat\"/>\n <xsd:enumeration value=\"LA_Chat_Ended_ChatEnd\"/>\n <xsd:enumeration value=\"LA_Chat_Ended_ChatEndAgent\"/>\n <xsd:enumeration value=\"LA_Chat_Ended_ChatEndConnectio
"declarative_metadata_sample_definition": [
{
"description": "The following is an example of a Choicelist component.",
"code": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<ChoiceList xmlns=\"http://soap.sforce.com/2006/04/metadata\">\n <choiceListValue>\n <embeddedServiceCustomLabels>\n <customLabel>EM_PreChat_ChoiceList_PrechatCustomFieldLabel_133xx0000004GG1_7741637</customLabel>\n <labelKey>EM_PreChat_ChoiceList_PrechatCustomFieldLabel</labelKey>\n <feature>EmbeddedMessaging</feature>\n </embeddedServiceCustomLabels>\n <isDefaultValue>true</isDefaultValue>\n <order>0</order>\n <valueName>Pizza</valueName>\n </choiceListValue>\n <choiceListValue>\n <embeddedServiceCustomLabels>\n <customLabel>EM_PreChat_ChoiceList_PrechatCustomFieldLabel_133xx0000004GG2_5523047</customLabel>\n <labelKey>EM_PreChat_ChoiceList_PrechatCustomFieldLabel</labelKey>\n <feature>EmbeddedMessaging</feature>\n </embeddedServiceCustomLabels>\n <isDefaultValue>false</isDefaultValue>\n <order>1</order>\n <valueName>Burger</valueName>\n </choiceListValue>\n <masterLabel>Food</masterLabel>\n <description>Food Choice List</description>\n</ChoiceList>"
}
]
}