mirror of
https://github.com/forcedotcom/afv-library.git
synced 2026-08-07 16:04:41 +08:00
139 lines
7.4 KiB
JSON
139 lines
7.4 KiB
JSON
{
|
||
"sections": [
|
||
"title",
|
||
"description",
|
||
"fields",
|
||
"usage",
|
||
"wsdl_segment",
|
||
"field_reference"
|
||
],
|
||
"title": "ApexComponent - Data API",
|
||
"description": "Represents a definition for a custom component that can be used in a Visualforce page alongside standard components such as <apex:relatedList> and <apex:dataTable>.",
|
||
"fields_columns": [
|
||
"type",
|
||
"properties",
|
||
"description"
|
||
],
|
||
"fields": {
|
||
"ApiVersion": {
|
||
"type": "double",
|
||
"properties": "Create, Filter, Sort, Update",
|
||
"description": "The API version for this custom component. Every custom component has an API version specified at creation. If the API version is less than 15.0 and ApiVersion is not specified, ApiVersion defaults to 15.0."
|
||
},
|
||
"ControllerKey": {
|
||
"type": "string",
|
||
"properties": "Create, Filter, Group, Nillable, Sort, Update",
|
||
"description": "The identifier for the controller associated with this custom component: If the ControllerType parameter is set to Standard or StandardSet, this value is the name of the sObject that defines the controller. If the ControllerType parameter is set to Custom, this value is the name of the Apex class that defines the controller."
|
||
},
|
||
"ControllerType": {
|
||
"type": "picklist",
|
||
"properties": "Create, Filter, Group, Restricted picklist, Sort, Update",
|
||
"description": "The type of controller associated with this Visualforce custom component. Possible values include: Not Specified, for custom components defined without a value for the controller attribute on the <apex:component> tag Standard, a value that can't be used with custom components or errors may occur StandardSet, a value that can't be used with custom components or errors may occur Custom, for components that have a value for the controller attribute on the <apex:component> tag"
|
||
},
|
||
"Description": {
|
||
"type": "textarea",
|
||
"properties": "Create, Filter, Nillable, Sort, Update",
|
||
"description": "Description of the Visualforce custom component."
|
||
},
|
||
"Markup": {
|
||
"type": "textarea",
|
||
"properties": "Create, Update",
|
||
"description": "The Visualforce markup, HTML, Javascript, and any other Web-enabled code that defines the content of the custom component."
|
||
},
|
||
"MasterLabel": {
|
||
"type": "string",
|
||
"properties": "Create, Filter, Group, Sort, Update",
|
||
"description": "The text used to identify the Visualforce custom component in the Setup area of Salesforce. The Label for this field is Label."
|
||
},
|
||
"Name": {
|
||
"type": "string",
|
||
"properties": "Create, Filter, Group, idLookup, Sort, Update",
|
||
"description": "Name of this Visualforce custom component.",
|
||
"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."
|
||
}
|
||
},
|
||
"usage": "Use custom components to encapsulate a common design pattern and then reuse that pattern several times in one or more Visualforce pages. All users who can view Visualforce pages can view custom components, but the “Customize Application” permission is required to create or update custom components.",
|
||
"wsdl_segment": "```xml\n<complexType name=\"ApexComponent\">\n <complexContent>\n <extension base=\"ens:sObject\">\n <sequence>\n <element name=\"ApiVersion\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:double\"/>\n <element name=\"ControllerKey\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"ControllerType\" 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=\"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=\"Markup\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\n <element name=\"MasterLabel\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:string\"/>\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=\"SystemModstamp\" nillable=\"true\" minOccurs=\"0\" type=\"xsd:dateTime\"/>\n </sequence>\n </extension>\n </complexContent>\n</complexType>\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```",
|
||
"field_reference": {
|
||
"ApiVersion": {
|
||
"field_label": "Api Version",
|
||
"type": "double",
|
||
"precision": "18",
|
||
"scale": "1"
|
||
},
|
||
"ControllerKey": {
|
||
"field_label": "Controller Key",
|
||
"type": "string",
|
||
"length": "255"
|
||
},
|
||
"ControllerType": {
|
||
"field_label": "Controller 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": "textarea",
|
||
"length": "4000"
|
||
},
|
||
"Id": {
|
||
"field_label": "Visualforce Component ID",
|
||
"type": "id",
|
||
"length": "18"
|
||
},
|
||
"LastModifiedById": {
|
||
"field_label": "Last Modified By ID",
|
||
"type": "reference",
|
||
"length": "18"
|
||
},
|
||
"LastModifiedDate": {
|
||
"field_label": "Last Modified Date",
|
||
"type": "datetime"
|
||
},
|
||
"Markup": {
|
||
"field_label": "Markup",
|
||
"type": "textarea",
|
||
"length": "1048576"
|
||
},
|
||
"MasterLabel": {
|
||
"field_label": "Label",
|
||
"type": "string",
|
||
"length": "80"
|
||
},
|
||
"Name": {
|
||
"field_label": "Name",
|
||
"type": "string",
|
||
"length": "80"
|
||
},
|
||
"NamespacePrefix": {
|
||
"field_label": "Namespace Prefix",
|
||
"type": "string",
|
||
"length": "15"
|
||
},
|
||
"SystemModstamp": {
|
||
"field_label": "System Modstamp",
|
||
"type": "datetime"
|
||
}
|
||
},
|
||
"field_reference_columns": [
|
||
"field_label",
|
||
"type",
|
||
"precision",
|
||
"scale",
|
||
"length"
|
||
]
|
||
} |