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

{
  "sections": [
    "title",
    "description",
    "file_information",
    "directory_location",
    "fields",
    "wsdl_segment",
    "declarative_metadata_sample_definition"
  ],
  "title": "Scontrol - Metadata API",
  "description": "Deprecated. Represents an Scontrol component, corresponding to an s-control in the Salesforce user interface.",
  "file_information": ".scf",
  "directory_location": "scontrols",
  "fields_columns": [
    "type",
    "description"
  ],
  "fields": {
    "content": {
      "type": "base64Binary",
      "description": "Content of the s-control. Base 64-encoded binary data. Before making an API call, client applications must encode the binary attachment data as base64. Upon receiving a response, client applications must decode the base64 data to binary. This conversion is handled for you by a SOAP client. This field is inherited from the MetadataWithContent component."
    },
    "contentSource": {
      "type": "SControlContentSource (enumeration of type string)",
      "description": "Determines how you plan to use the s-control: HTML: Select this option if you want to enter the content for your s-control in content. URL: Select this option if you want to enter the link or URL of an external website in content. Snippet: Snippets are s-controls that are designed to be included in other s-controls. Select this option if you want to enter the content for your s-control snippet in content.",
      "required": true
    },
    "description": {
      "type": "string",
      "description": "Optional text that describes the s-control. This only displays to users with View All Data permission (administrator)."
    },
    "encodingKey": {
      "type": "Encoding (enumeration of type string)",
      "description": "The default encoding setting is Unicode: UTF-8. Change it if you’re passing information to a URL that requires data in a different format. This option is available when you select URL as the value for contentSource.",
      "required": true
    },
    "fileContent": {
      "type": "base64",
      "description": "File contents displayed if you add this s-control to a custom link. The file can contain a Java applet, Active-X control, or any other type of content you want. This option only applies to s-controls with a value of HTML for contentSource."
    },
    "fileName": {
      "type": "string",
      "description": "The unique name for the s-control. This name can contain only underscores and alphanumeric characters, and must be unique in your org. It must begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. This field can’t be changed for components installed by a managed package. It’s only relevant if the fileContent field also has a value. This field is available in API version 14.0."
    },
    "fullName": {
      "type": "string",
      "description": "The s-control developer name used as a unique identifier for API access. The fullName can contain only underscores and alphanumeric characters. It must be unique, begin with a letter, not include spaces, not end with an underscore, and not contain two consecutive underscores. If this field contained characters before version 14.0 that are no longer allowed, the characters were stripped out of this field, and the previous value of the field was saved in the name field. This field is inherited from the Metadata component."
    },
    "name": {
      "type": "string",
      "description": "The unique name for the s-control. It must contain alphanumeric characters only and begin with a letter. For example example_s_control.",
      "required": true
    },
    "supportsCaching": {
      "type": "boolean",
      "description": "Indicates whether the s-control supports caching (true) or not (false). Caching optimizes the page so that it remembers which s-controls are on the page when it reloads. This option only applies to HTML s-controls.",
      "required": true
    }
  },
  "wsdl_segment": "```xml\n<xsd:simpleType name=\"Encoding\">\n  <xsd:restriction base=\"xsd:string\">\n    <xsd:enumeration value=\"UTF-8\"/>\n    <xsd:enumeration value=\"ISO-8859-1\"/>\n    <xsd:enumeration value=\"Shift_JIS\"/>\n    <xsd:enumeration value=\"ISO-2022-JP\"/>\n    <xsd:enumeration value=\"EUC-JP\"/>\n    <xsd:enumeration value=\"ks_c_5601-1987\"/>\n    <xsd:enumeration value=\"Big5\"/>\n    <xsd:enumeration value=\"GB2312\"/>\n    <xsd:enumeration value=\"Big5-HKSCS\"/>\n    <xsd:enumeration value=\"x-SJIS_0213\"/>\n  </xsd:restriction>\n</xsd:simpleType>\n<xsd:complexType name=\"Metadata\">\n  <xsd:sequence>\n    <xsd:element name=\"fullName\" minOccurs=\"0\" type=\"xsd:string\"/>\n  </xsd:sequence>\n</xsd:complexType>\n<xsd:complexType name=\"MetadataWithContent\">\n  <xsd:complexContent>\n    <xsd:extension base=\"tns:Metadata\">\n      <xsd:sequence>\n        <xsd:element name=\"content\" minOccurs=\"0\" type=\"xsd:base64Binary\"/>\n      </xsd:sequence>\n    </xsd:extension>\n  </xsd:complexContent>\n</xsd:complexType>\n<xsd:simpleType name=\"SControlContentSource\">\n  <xsd:restriction base=\"xsd:string\">\n    <xsd:enumeration value=\"HTML\"/>\n    <xsd:enumeration value=\"URL\"/>\n    <xsd:enumeration value=\"Snippet\"/>\n  </xsd:restriction>\n</xsd:simpleType>\n<xsd:complexType name=\"Scontrol\">\n  <xsd:complexContent>\n    <xsd:extension base=\"tns:MetadataWithContent\">\n      <xsd:sequence>\n        <xsd:element name=\"contentSource\" type=\"tns:SControlContentSource\"/>\n        <xsd:element name=\"description\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"encodingKey\" type=\"tns:Encoding\"/>\n        <xsd:element name=\"fileContent\" minOccurs=\"0\" type=\"xsd:base64Binary\"/>\n        <xsd:element name=\"fileName\" minOccurs=\"0\" type=\"xsd:string\"/>\n        <xsd:element name=\"name\" type=\"xsd:string\"/>\n        <xsd:element name=\"supportsCaching\" type=\"xsd:boolean\"/>\n      </xsd:sequence>\n    </xsd:extension>\n  </xsd:complexContent>\n</xsd:complexType>\n```",
  "declarative_metadata_sample_definition": [
    {
      "description": "Myriad_Publishing.scf file:",
      "code": "http://www.myriadpubs.com"
    },
    {
      "description": "Myriad_Publishing.scf-meta.xml:",
      "code": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<Scontrol xmlns=\"http://soap.sforce.com/2006/04/metadata\">\n    <contentSource>URL</contentSource>\n    <description>s-control to open Myriad Publishing website.</description>\n    <encodingKey>UTF-8</encodingKey>\n    <name>Myriad Publishing</name>\n    <supportsCaching>true</supportsCaching>\n</Scontrol>"
    }
  ]
}