Represents the working copy of a Visualforce page 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
| Body |
- Type
- string
- Properties
- Create, Update
- Description
- The data for the Visualforce page.
The Body field is the only field you
can update() or PATCH.
|
| Content |
- Type
- string
- Properties
- None
- Description
- A string representation of ApexPageMetadata that lists the version,
status, and packaged versions of the corresponding Visualforce page.
|
| ContentEntityId |
- Type
- reference
- Properties
- Create, Filter, Group, Sort
- Description
- A reference to a Visualforce page.
There can be only one ContentEntityId per ApexPageMember, otherwise, an error is reported.
This
field is required.
|
| LastSyncDate |
- Type
- dateTime
- Properties
- Filter, Sort
- Description
- The date that this ApexPageMember Body was
replicated from the underlying entity.
When you deploy a MetadataContainer,
this value is compared with the LastModifiedDate of the underlying Visualforce page. If LastSyncDate is older than LastModifiedDate, the deployment fails with an error.
|
| Metadata |
- Type
- ApexPageMetadata
- Properties
- None
- Description
- An object that describes the version, status, and packaged versions
of the corresponding Visualforce page.
|
| 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 page, create an ApexPageMember object that references it. To create
a new Visualforce page, use the Force.com REST API or the Metadata API.
Once an ApexPageMember is successfully
deployed in a MetadataContainer, the MetadataContainerId is changed
to the ID of the ContainerAsyncRequest, and the ApexPageMember can’t be modified or
reused.
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 ApexPageMember and ApexComponentMember objects
in a single MetadataContainer object. Use ContainerAsyncRequest to
send the MetadataContainer to the application server.
Each
ApexPageMember object can only refer to a single MetadataContainer
object. Multiple ApexPageMember objects can refer to the same MetadataContainer
object.