Force.com Tooling API Developer's Guide

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

ApexComponentMember

Represents the working copy of a Visualforce component 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
Body
Type
string
Properties
Create, Update
Description
The data for the Visualforce component.

The Body field is the only field you can update() or PATCH.
Content
Type
string
Properties
None
Description
A string representation of ApexComponentMetadata that lists the version, status, and packaged versions of the corresponding Visualforce component.
ContentEntityId
Type
reference
Properties
Create, Filter, Group, Sort
Description
A reference to a Visualforce component.

There can be only one ContentEntityId per ApexComponentMember, otherwise, an error is reported.

This field is required.
LastSyncDate
Type
dateTime
Properties
Filter, Sort
Description
The date that this ApexComponentMember Body was replicated from the underlying entity. 

When you deploy a MetadataContainer, this value is compared with the LastModifiedDate of the underlying Visualforce component. If LastSyncDate is older than LastModifiedDate, the deployment fails with an error.

Metadata
Type
ApexComponentMetadata
Properties
None
Description
An object that describes the version, status, and packaged versions of the corresponding Visualforce component.
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.

Usage

To edit, save, or compile a Visualforce component, create an ApexComponentMember object that references it. To create a new Visualforce component, use the Force.com REST API or the Metadata API.

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

Note

Visualforce pages and components are often dependent on each other for functionality. To successfully save and compile a group of related source files, put the corresponding ApexComponentMember and ApexPageMember objects in a single MetadataContainer object.

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