mirror of
https://github.com/forcedotcom/afv-library.git
synced 2026-08-06 15:59:59 +08:00
170 lines
8.8 KiB
JSON
170 lines
8.8 KiB
JSON
{
|
||
"sections": [
|
||
"title",
|
||
"description",
|
||
"fields",
|
||
"usage",
|
||
"wsdl_segment",
|
||
"field_reference"
|
||
],
|
||
"title": "Scontrol - Data API",
|
||
"description": "A custom s-control, which is custom content that is hosted by the system but executed by the client application.",
|
||
"fields_columns": [
|
||
"type",
|
||
"properties",
|
||
"description"
|
||
],
|
||
"fields": {
|
||
"Binary": {
|
||
"type": "base64",
|
||
"properties": "Create, Nillable, Update",
|
||
"description": "Binary content of this custom s-control, such as an ActiveX control or a Java archive. Can be specified when created, but not when updated. Limit: 5 MB."
|
||
},
|
||
"BodyLength": {
|
||
"type": "int",
|
||
"properties": "Filter, Group, Sort",
|
||
"description": "The length of the custom s-control. Label is Binary Length."
|
||
},
|
||
"ContentSource": {
|
||
"type": "picklist",
|
||
"properties": "Create, Filter, Group, Nillable, Restricted picklist, Sort, Update",
|
||
"description": "Specifies the source of the s-control content, either custom HTML, a snippet (s-controls that are included in other s-controls), or a URL."
|
||
},
|
||
"Description": {
|
||
"type": "string",
|
||
"properties": "Create, Filter, Group, Nillable, Sort, Update",
|
||
"description": "Description of the custom s-control."
|
||
},
|
||
"DeveloperName": {
|
||
"type": "string",
|
||
"properties": "Create, Filter, Group, Sort, Update",
|
||
"description": "The unique name of the object in the API. 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. In managed packages, this field prevents naming conflicts on package installations. With this field, a developer can change the object’s name in a managed package and the changes are reflected in a subscriber’s organization. Label is S-Control Name. Note: When creating large sets of data, always specify a unique DeveloperName for each record. If no DeveloperName is specified, performance slows down while Salesforce generates one for each record."
|
||
},
|
||
"EncodingKey": {
|
||
"type": "picklist",
|
||
"properties": "Create, Filter, Group, Restricted picklist, Sort, Update",
|
||
"description": "Picklist of character set encodings, including ISO-08859-1, UTF-8, EUC, JIS, Shift-JIS, Korean (ks_c_5601-1987), Simplified Chinese (GB2312), and Traditional Chinese (Big5)."
|
||
},
|
||
"Filename": {
|
||
"type": "string",
|
||
"properties": "Create, Filter, Group, Nillable, Sort, Update",
|
||
"description": "An uploaded object to display when the custom s-control is added to a custom link. Can be a Java applet, an ActiveX control, or any other type of desired content."
|
||
},
|
||
"HtmlWrapper": {
|
||
"type": "textarea",
|
||
"properties": "Create, Update",
|
||
"description": "HTML page that will be delivered when the user views this custom s-control. This HTML page can be the entire content of the custom s-control, or it can reference the binary. Limit: 1,048,576 characters. Label is HTML Body.",
|
||
"required": true
|
||
},
|
||
"Name": {
|
||
"type": "string",
|
||
"properties": "Create, Filter, Group, Sort, Update",
|
||
"description": "Name of this custom s-control. Label is Label.",
|
||
"required": true
|
||
},
|
||
"NamespacePrefix": {
|
||
"type": "string",
|
||
"properties": "Filter, Group, Nillable, Sort",
|
||
"description": "The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix__componentName notation. The namespace prefix can have one of the following values. In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer. In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix."
|
||
},
|
||
"SupportsCaching": {
|
||
"type": "boolean",
|
||
"properties": "Create, Defaulted on create, Filter, Group, Sort, Update",
|
||
"description": "Indicates whether the s-control supports caching (true) or not (false)."
|
||
}
|
||
},
|
||
"usage": "Use custom s-controls to manage custom content that extends application functionality. All users can view custom s-controls, but the “Customize Application” permission is required to create or update custom s-controls.",
|
||
"wsdl_segment": "```xml\n<simpleType name=\"ID\">\n <restriction base=\"xsd:string\">\n <length value=\"18\"/>\n <pattern value=\"[a-zA-Z0-9]{18}\"/>\n </restriction>\n</simpleType>\n<complexType name=\"Scontrol\">\n <complexContent>\n <extension base=\"ens:sObject\">\n <sequence>\n <element name=\"Binary\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:base64Binary\"/>\n <element name=\"BodyLength\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:int\"/>\n <element name=\"ContentSource\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"CreatedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n <element name=\"CreatedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"CreatedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"Description\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"DeveloperName\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"EncodingKey\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"Filename\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"HtmlWrapper\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"IsDeleted\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"LastModifiedBy\" nillable=\"true\" minOccurs=\"0\" type=\"ens:User\"/>\n <element name=\"LastModifiedById\" nillable=\"true\" minOccurs=\"0\" type=\"tns:ID\"/>\n <element name=\"LastModifiedDate\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n <element name=\"Name\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"NamespacePrefix\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"SupportsCaching\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:boolean\"/>\n <element name=\"SystemModstamp\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n </sequence>\n </extension>\n </complexContent>\n</complexType>\n```",
|
||
"field_reference": {
|
||
"Binary": {
|
||
"field_label": "Binary",
|
||
"type": "base64"
|
||
},
|
||
"BodyLength": {
|
||
"field_label": "Binary Length",
|
||
"type": "int",
|
||
"digits": "8"
|
||
},
|
||
"ContentSource": {
|
||
"field_label": "Type",
|
||
"type": "picklist",
|
||
"length": "40"
|
||
},
|
||
"CreatedById": {
|
||
"field_label": "Created By ID",
|
||
"type": "reference",
|
||
"length": "18"
|
||
},
|
||
"CreatedDate": {
|
||
"field_label": "Created Date",
|
||
"type": "datetime"
|
||
},
|
||
"Description": {
|
||
"field_label": "Description",
|
||
"type": "string",
|
||
"length": "255"
|
||
},
|
||
"DeveloperName": {
|
||
"field_label": "S-Control Name",
|
||
"type": "string",
|
||
"length": "80"
|
||
},
|
||
"EncodingKey": {
|
||
"field_label": "Encoding",
|
||
"type": "picklist",
|
||
"length": "40"
|
||
},
|
||
"Filename": {
|
||
"field_label": "Filename",
|
||
"type": "string",
|
||
"length": "255"
|
||
},
|
||
"HtmlWrapper": {
|
||
"field_label": "HTML Body",
|
||
"type": "textarea",
|
||
"length": "1048576"
|
||
},
|
||
"Id": {
|
||
"field_label": "Custom S-Control ID",
|
||
"type": "id",
|
||
"length": "18"
|
||
},
|
||
"IsDeleted": {
|
||
"field_label": "Deleted",
|
||
"type": "boolean"
|
||
},
|
||
"LastModifiedById": {
|
||
"field_label": "Last Modified By ID",
|
||
"type": "reference",
|
||
"length": "18"
|
||
},
|
||
"LastModifiedDate": {
|
||
"field_label": "Last Modified Date",
|
||
"type": "datetime"
|
||
},
|
||
"Name": {
|
||
"field_label": "Label",
|
||
"type": "string",
|
||
"length": "80"
|
||
},
|
||
"NamespacePrefix": {
|
||
"field_label": "Namespace Prefix",
|
||
"type": "string",
|
||
"length": "15"
|
||
},
|
||
"SupportsCaching": {
|
||
"field_label": "Prebuild In Page",
|
||
"type": "boolean"
|
||
},
|
||
"SystemModstamp": {
|
||
"field_label": "System Modstamp",
|
||
"type": "datetime"
|
||
}
|
||
},
|
||
"field_reference_columns": [
|
||
"field_label",
|
||
"type",
|
||
"digits",
|
||
"length"
|
||
]
|
||
} |