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

40 lines
2.1 KiB
JSON
Raw Normal View History

{
"sections": [
"title",
"description",
"file_information",
"directory_location",
"fields",
"wsdl_segment",
"declarative_metadata_sample_definition"
],
"title": "TrailheadSettings - Metadata API",
"description": "Represents an orgs integration with Trailhead for Learning Paths or Enablement programs, including access to enablement sites (formerly myTrailhead).",
"file_information": ".settings",
"directory_location": "settings",
"fields_columns": [
"type",
"description"
],
"fields": {
"enableConfettiEffect": {
"type": "boolean",
"description": "Indicates whether animated confetti plays on the screen after a user reaches certain milestones, such as completing an Enablement program in the Guidance Center. The default value of this field is false."
},
"enableMyTrailheadPref": {
"type": "boolean",
"description": "Indicates whether the org is connected to an enablement site (myTrailhead). The default value of this field is true."
},
"enableTrailheadInLexTerms": {
"type": "boolean",
"description": "Indicates whether the terms and conditions for showing Trailhead content in Lightning Experience are accepted in your org. The default value of this field is false."
}
},
"wsdl_segment": "```xml\n<xsd:complexType name=\"TrailheadSettings\">\n <xsd:complexContent>\n <xsd:extension base=\"tns:Metadata\">\n <xsd:sequence>\n <xsd:element name=\"enableConfettiEffect\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <xsd:element name=\"enableMyTrailheadPref\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <xsd:element name=\"enableTrailheadInLexTerms\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n </xsd:sequence>\n </xsd:extension>\n </xsd:complexContent>\n</xsd:complexType>\n```",
"declarative_metadata_sample_definition": [
{
"description": "The following is an example of a TrailheadSettings component.",
"code": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<TrailheadSettings xmlns=\"http://soap.sforce.com/2006/04/metadata\">\n <enableMyTrailheadPref>true</enableMyTrailheadPref>\n</TrailheadSettings>"
}
]
}