Force.com Tooling API

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
PDF

Newer Version Available

This content describes an older version of this product. View Latest

ApexClassMember

Represents the working copy of an Apex class for editing, saving or compiling in a MetadataContainer.

Supported SOAP API Calls

create(), delete(), describeSObjects(), query(), retrieve(), update(), upsert()

Supported REST API HTTP Methods

Query, GET, POST, PATCH, DELETE

Fields

Field Name Details
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.
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.
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.
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 cannot be created. A symbol table cannot be created if the content referenced by the ContentEntityId field doesn’t use a symbol table, or if compiler errors for the last deployment of the MetadataContainer in the MetadataContainerId field prevented a symbol table from being created.

Usage

To edit, save, or compile an Apex class, create an ApexClassMember object that references it.

Once an ApexClassMember is successfully deployed in a MetadataContainer, the MetadataContainerId is changed to the ID of the ContainerAsyncRequest, and the ApexClassMember can’t be modified or reused.

Note

Apex classes are often dependent on each other for functionality. For example, a method in one class can call a method in another class. If source file A is dependent on modified source file B and you try to save and compile source file A before you’ve saved the changes to source file B, the compiler will throw an error. To successfully save and compile a group of related source files, put the corresponding ApexClassMember and ApexTriggerMember objects in a single MetadataContainer object.

Each ApexClassMember object can only refer to a single MetadataContainer object. Multiple ApexClassMember objects can refer to the same MetadataContainer object.