Force.com Tooling API Developer's Guide
j
No Results
Search Tips:
- Please consider misspellings
- Try different search keywords
Newer Version Available
Tooling API Objects
Tooling API includes the following objects:
| Object | Description |
|---|---|
| ApexClass | Represents the saved copy of an Apex class. ApexClass uses the cached version of the class unless one is unavailable. |
| ApexClassMember | Represents the working copy of an Apex class for editing, saving or compiling in a MetadataContainer. |
| ApexCodeCoverage | Represents code coverage test results for an Apex class or trigger. |
| ApexCodeCoverageAggregate | Represents aggregate code coverage test results for an Apex class or trigger. |
| ApexComponent | Represents the saved copy of aVisualforce component. ApexComponent uses the cached version of the class unless one is unavailable. |
| ApexComponentMember | Represents the working copy of a Visualforce component for editing, saving or compiling in a MetadataContainer. |
| ApexExecutionOverlayAction | Specifies an Apex code snippet or SOQL query to execute at a specific line of code in an Apex class or trigger and optionally generate a heap dump. |
| ApexExecutionOverlayResult | Represents the result from the Apex code snippet or SOQL query defined in the associated ApexExecutionOverlayAction, and the resulting heap dump if one was returned. |
| ApexLog | Represents a debug log. |
| ApexPage | Represents the saved copy of an Apex page. ApexPage uses the cached version of the class unless one is unavailable. |
| ApexPageMember | Represents the working copy of a Visualforce page for editing, saving or compiling in a MetadataContainer. |
| ApexTestQueueItem | Represents a single Apex class in the Apex job queue. |
| ApexTestResult | Represents the result of an Apex test method execution. |
| ApexTrigger | Represents the saved copy of an Apex page. ApexTrigger uses the cached version of the class unless one is unavailable. |
| ApexTriggerMember | Represents the working copy of an Apex trigger for editing, saving or compiling in a MetadataContainer. |
| ContainerAsyncRequest | Allows you to compile and asynchronously deploy a MetadataContainer object to your organization. |
| CustomField | Represents a custom field on a custom object that stores data unique to your organization. |
| FieldHistoryRetentionJob | Specifies the date range for the retention of field history data, beyond the standard 18 months of data retention that Salesforce provides. |
| MetadataContainer | Manages working copies of ApexClassMember, ApexTriggerMember, ApexPageMember and ApexComponentMember objects, including collections of objects that should be deployed together. |
| StaticResource | Represents the working copy of a static resource file for editing or saving. Static resources allow you to upload content that you can reference in a Visualforce page, including images, stylesheets, JavaScript, and other files. |
| TraceFlag | Represents a trace flag that triggers an Apex debug log at the specified logging level. |
| ValidationRule | Represents a formula that is used for specifying when a criteria is met. This includes both validation rules and workflow rules. Includes access to the associated ValidationRule object in Salesforce Metadata API. |
| WorkflowRule | Represents a workflow rule that is used to fire off a specific workflow action when the specified criteria is met. Creation and modification of workflow rules isn't supported. Includes access to the associated WorkflowRule object in Salesforce Metadata API. |
This section also provides details on the following complex types:
| Object | Description |
|---|---|
| ApexResult | A complex type that represents the result of Apex code executed as part of an ApexExecutionOverlayAction, returned in an ApexExecutionOverlayResult. |
| HeapDump | A complex type that represents a heap dump in an ApexExecutionOverlayResult. |
| SOQLResult | A complex type that represents the result of a SOQL query in an ApexExecutionOverlayResult. |
| SymbolTable | 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. |
The following Tooling API objects are
used internally by the Developer Console.
IDEPerspective
IDEWorkspace
User.WorkspaceId