mirror of
https://github.com/forcedotcom/afv-library.git
synced 2026-08-05 14:54:50 +08:00
64 lines
9.5 KiB
JSON
64 lines
9.5 KiB
JSON
{
|
||
"sections": [
|
||
"title",
|
||
"description",
|
||
"supported_soap_calls",
|
||
"supported_rest_api_http_methods",
|
||
"fields",
|
||
"special_access_rules",
|
||
"wsdl_segment"
|
||
],
|
||
"title": "ApexClassMember - Tooling API",
|
||
"description": "Represents the working copy of an Apex class for editing, saving, or compiling in a MetadataContainer.",
|
||
"supported_soap_calls": "`create()`, `delete()`, `describeSObjects()`, `query()`, `retrieve()`, `update()`, `upsert()`",
|
||
"supported_rest_api_http_methods": "`Query`, `GET`, `POST`, `PATCH`, `DELETE`",
|
||
"fields_columns": [
|
||
"type",
|
||
"properties",
|
||
"description"
|
||
],
|
||
"fields": {
|
||
"Body": {
|
||
"type": "string",
|
||
"properties": "Create, Update",
|
||
"description": "The data for the Apex class. The Body field is the only field you can update() or PATCH."
|
||
},
|
||
"Content": {
|
||
"type": "string",
|
||
"properties": "None",
|
||
"description": "A string representation of ApexClassMetadata that lists the version, status, and packaged versions of the corresponding Apex class."
|
||
},
|
||
"ContentEntityId": {
|
||
"type": "reference",
|
||
"properties": "Create, Filter, Group, Sort",
|
||
"description": "A reference to an Apex class. There can be only one ContentEntityId per ApexClassMember, otherwise, an error is reported. This field is required if FullName is not specified."
|
||
},
|
||
"FullName": {
|
||
"type": "string",
|
||
"properties": "Group, Nillable",
|
||
"description": "The full name of the associated object in the Metadata API. Use to avoid race conditions on create, before you have IDs. Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance. This field is required if ContentEntityId is not specified."
|
||
},
|
||
"LastSyncDate": {
|
||
"type": "dateTime",
|
||
"properties": "Filter, Sort",
|
||
"description": "The date and time that this ApexClassMember Body was replicated from the underlying Apex class. When you deploy a MetadataContainer, this value is compared with the LastModifiedDate of the underlying Apex class. If LastSyncDate is older than LastModifiedDate, the deployment fails with an error."
|
||
},
|
||
"Metadata": {
|
||
"type": "ApexClassMetadata",
|
||
"properties": "None",
|
||
"description": "An object that describes the version, status, and packaged versions of the corresponding Apex class. Query this field only if the query result contains no more than one record. Otherwise, an error is returned. If more than one record exists, use multiple queries to retrieve the records. This limit protects performance."
|
||
},
|
||
"MetadataContainerId": {
|
||
"type": "reference",
|
||
"properties": "Create, Filter, Group, Sort",
|
||
"description": "A reference to a MetadataContainer or ContainerAsyncRequest object. As part of a successful deployment, this field is reset from the ID of the deployed MetadataContainer to the ID of the corresponding ContainerAsyncRequest object. This field is required."
|
||
},
|
||
"SymbolTable": {
|
||
"type": "SymbolTable",
|
||
"properties": "Nillable",
|
||
"description": "A complex type that represents all user-defined tokens in the Body of an ApexClass, ApexClassMember, or ApexTriggerMember and their associated line and column locations within the Body. This field is null if the symbol table can’t be created. A symbol table can’t be created if the content referenced by the ContentEntityId field doesn’t use a symbol table. Compiler errors for the last deployment of the MetadataContainer in the MetadataContainerId field also prevent a symbol table from being created."
|
||
}
|
||
},
|
||
"special_access_rules": "As of the Spring '20 release, to access ApexClassMember you must have both the View All Data and the Author Apex user permissions.",
|
||
"wsdl_segment": "```xml\n<xsd:complexType name=\"Annotation\">\n <xsd:sequence>\n <xsd:element name=\"name\" type=\"xsd:string\"/>\n </xsd:sequence>\n</xsd:complexType>\n<xsd:complexType name=\"ApexClassMember\">\n <xsd:complexContent>\n <xsd:extension base=\"ens:sObject\">\n <xsd:sequence>\n <xsd:element name=\"FullName\" minOccurs=\"0\" type=\"xsd:string\" nillable=\"true\"/>\n <xsd:element name=\"Metadata\" minOccurs=\"0\" type=\"mns:ApexClass\" nillable=\"true\"/>\n </xsd:sequence>\n </xsd:extension>\n </xsd:complexContent>\n</xsd:complexType>\n\n\n<xsd:complexType name=\"ApexClass\">\n <xsd:complexContent>\n <xsd:extension base=\"mns:Metadata\">\n <xsd:sequence>\n <xsd:element name=\"apiVersion\" type=\"xsd:double\"/>\n <xsd:element name=\"packageVersions\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"mns:PackageVersion\"/>\n <xsd:element name=\"status\" type=\"tns:ApexCodeUnitStatus\"/>\n </xsd:sequence>\n </xsd:extension>\n </xsd:complexContent>\n</xsd:complexType>\n<xsd:complexType name=\"Constructor\">\n <xsd:complexContent>\n <xsd:extension base=\"tns:VisibilitySymbol\">\n <xsd:sequence>\n <xsd:element name=\"parameters\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:Parameter\"/>\n </xsd:sequence>\n </xsd:extension>\n </xsd:complexContent>\n</xsd:complexType>\n<xsd:complexType name=\"ExternalConstructor\">\n <xsd:complexContent>\n <xsd:extension base=\"tns:ExternalSymbol\">\n <xsd:sequence>\n <xsd:element name=\"methodDoc\" type=\"xsd:string\"/>\n <xsd:element name=\"parameters\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:Parameter\"/>\n </xsd:sequence>\n </xsd:extension>\n </xsd:complexContent>\n</xsd:complexType>\n<xsd:complexType name=\"ExternalMethod\">\n <xsd:complexContent>\n <xsd:extension base=\"tns:ExternalConstructor\">\n <xsd:sequence>\n <xsd:element name=\"argTypes\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"xsd:string\"/>\n <xsd:element name=\"isStatic\" type=\"xsd:boolean\"/>\n <xsd:element name=\"returnType\" type=\"xsd:string\"/>\n </xsd:sequence>\n </xsd:extension>\n </xsd:complexContent>\n</xsd:complexType>\n<xsd:complexType name=\"ExternalReference\">\n <xsd:sequence>\n <xsd:element name=\"methods\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:ExternalMethod\"/>\n <xsd:element name=\"name\" type=\"xsd:string\"/>\n <xsd:element name=\"namespace\" type=\"xsd:string\"/>\n <xsd:element name=\"references\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:Position\"/>\n <xsd:element name=\"variables\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:ExternalSymbol\"/>\n </xsd:sequence>\n</xsd:complexType>\n<xsd:complexType name=\"ExternalSymbol\">\n <xsd:sequence>\n <xsd:element name=\"name\" type=\"xsd:string\"/>\n <xsd:element name=\"references\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:Position\"/>\n </xsd:sequence>\n</xsd:complexType>\n<xsd:simpleType name=\"ID\">\n <xsd:restriction base=\"xsd:string\">\n <xsd:length value=\"18\"/>\n <xsd:pattern value=\"[a-zA-Z0-9]{18}\"/>\n </xsd:restriction>\n</xsd:simpleType>\n<xsd:complexType name=\"Method\">\n <xsd:complexContent>\n <xsd:extension base=\"tns:Constructor\">\n <xsd:sequence>\n <xsd:element name=\"returnType\" type=\"xsd:string\"/>\n </xsd:sequence>\n </xsd:extension>\n </xsd:complexContent>\n</xsd:complexType>\n<xsd:complexType name=\"Parameter\">\n <xsd:sequence>\n <xsd:element name=\"name\" type=\"xsd:string\"/>\n <xsd:element name=\"type\" type=\"xsd:string\"/>\n </xsd:sequence>\n</xsd:complexType>\n<xsd:complexType name=\"Position\">\n <xsd:sequence>\n <xsd:element name=\"column\" type=\"xsd:int\"/>\n <xsd:element name=\"line\" type=\"xsd:int\"/>\n </xsd:sequence>\n</xsd:complexType>\n<xsd:complexType name=\"Symbol\">\n <xsd:sequence>\n <xsd:element name=\"annotations\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:Annotation\"/>\n <xsd:element name=\"location\" type=\"tns:Position\"/>\n <xsd:element name=\"modifiers\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"xsd:string\"/>\n <xsd:element name=\"name\" type=\"xsd:string\"/>\n <xsd:element name=\"references\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:Position\"/>\n <xsd:element name=\"type\" type=\"xsd:string\"/>\n </xsd:sequence>\n</xsd:complexType>\n<xsd:complexType name=\"SymbolTable\">\n <xsd:sequence>\n <xsd:element name=\"constructors\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:Constructor\"/>\n <xsd:element name=\"externalReferences\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:ExternalReference\"/>\n <xsd:element name=\"id\" type=\"xsd:string\"/>\n <xsd:element name=\"innerClasses\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:SymbolTable\"/>\n <xsd:element name=\"interfaces\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"xsd:string\"/>\n <xsd:element name=\"methods\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:Method\"/>\n <xsd:element name=\"name\" type=\"xsd:string\"/>\n <xsd:element name=\"namespace\" type=\"xsd:string\"/>\n <xsd:element name=\"parentClass\" type=\"xsd:string\"/>\n <xsd:element name=\"properties\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:VisibilitySymbol\"/>\n <xsd:element name=\"tableDeclaration\" type=\"tns:Symbol\"/>\n <xsd:element name=\"variables\" minOccurs=\"0\" maxOccurs=\"unbounded\" type=\"tns:Symbol\"/>\n </xsd:sequence>\n</xsd:complexType>\n<xsd:complexType name=\"VisibilitySymbol\">\n <xsd:complexContent>\n <xsd:extension base=\"tns:Symbol\">\n <xsd:sequence/>\n </xsd:extension>\n </xsd:complexContent>\n</xsd:complexType>\n```"
|
||
} |