Apex Reference Guide

Apex Reference Guide
Release Notes
Apex DML Operations
ApexPages Namespace
AppLauncher Namespace
Approval Namespace
Auth Namespace
Cache Namespace
Canvas Namespace
ChatterAnswers Namespace
CommerceBuyGrp Namespace
CommerceExtension Namespace
CommerceOrders Namespace
CommercePayments Namespace
CommerceTax Namespace
commonserviceexcellence Namespace
ComplianceMgmt Namespace
Compression Namespace
ConnectApi Namespace
Context Namespace
Database Namespace
Datacloud Namespace
DataRetrieval Namespace
DataSource Namespace
DataWeave Namespace
Dom Namespace
embeddedai Namespace
EventBus Namespace
ExternalService Namespace
Flow Namespace
Flowtesting Namespace
flowuiruntime Namespace
FormulaEval Namespace
disputemanagement Namespace
fsccashflow Namespace
fsccomplaintmanagement Namespace
fschousehold Namespace
fscserviceprocesses Namespace
fscwmgen Namespace
industriespersonalizedfinance Namespace
Functions Namespace
ise_bots_apex Namespace
IssueCreditMemo Namespace
ind_mfg_sample_mgmt_apex Namespace
industriesNlpSvc
IndustriesDigitalLending Namespace
Invocable Namespace
InvoiceWriteOff Namespace
IsvPartners Namespace
KbManagement Namespace
LxScheduler Namespace
Messaging Namespace
Metadata Namespace
AnalyticsCloudComponentLayoutItem Class
ConsoleComponent Class
Container Class
CustomConsoleComponents Class
CustomMetadata Class
CustomMetadataValue Class
DeployCallback Interface
DeployCallbackContext Class
DeployContainer Class
DeployContainer Methods
DeployDetails Class
DeployMessage Class
DeployProblemType Enum
DeployResult Class
DeployStatus Enum
FeedItemTypeEnum Enum
FeedLayout Class
FeedLayoutComponent Class
FeedLayoutComponentType Enum
FeedLayoutFilter Class
FeedLayoutFilterPosition Enum
FeedLayoutFilterType Enum
Layout Class
LayoutColumn Class
LayoutHeader Enum
LayoutItem Class
LayoutSection Class
LayoutSectionStyle Enum
Metadata Class
MetadataType Enum
MetadataValue Class
MiniLayout Class
Operations Class
PlatformActionList Class
PlatformActionListContextEnum Enum
PlatformActionListItem Class
PlatformActionTypeEnum Enum
PrimaryTabComponents Class
QuickActionList Class
QuickActionListItem Class
RelatedContent Class
RelatedContentItem Class
RelatedList Class
RelatedListItem Class
ReportChartComponentLayoutItem Class
ReportChartComponentSize Enum
SidebarComponent Class
SortOrder Enum
StatusCode Enum
SubtabComponents Class
SummaryLayoutStyleEnum Enum
SummaryLayout Class
SummaryLayoutItem Class
UiBehavior Enum
PlaceQuote Namespace
Pref_center Namespace
Process Namespace
QuickAction Namespace
renew_assets_summary Namespace
Reports Namespace
RevSignaling Namespace
RevSalesTrxn Namespace
RichMessaging Namespace
RulesAppln Namespace
runtime_industries_cpq Namespace
runtime_industries_insurance Namespace
Schema Namespace
Search Namespace
setup_flow_performance Namespace
Sfc Namespace
Sfdc_Checkout Namespace
Sfdc_Enablement Namespace
sfdc_surveys Namespace
sfdw Namespace
sfsqlquery Namespace
Site Namespace
Slack Namespace
Support Namespace
System Namespace
TerritoryMgmt Namespace
TxnSecurity Namespace
UserProvisioning Namespace
VisualEditor Namespace
Wave Namespace
Appendices
PDF

Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

DeployContainer Class

Represents a container for custom metadata components to be deployed.

Namespace

Metadata

Usage

Use Metadata.DeployContainer to manage custom metadata components for deployment. A container must have one or more components before being deployed.

Example

1// Use DeployContainer for deployment
2Metadata.DeployContainer mdContainer = new Metadata.DeployContainer();
3mdContainer.addMetadata(customMetadata);
4
5...
6
7// Enqueue deploy
8Metadata.Operations.enqueueDeployment(mdContainer, callback);

DeployContainer Methods

The following are methods for DeployContainer.

addMetadata(md)

Add a custom metadata component to the container.

Signature

public void addMetadata(Metadata.Metadata md)

Parameters

  • md:

    Type: Metadata.Metadata

    A custom metadata component class that derives from Metadata.Metadata. Avoid adding components to a Metadata.DeployContainerthat have the same Metadata.Metadata.fullName because it causes deployment errors.

Return Value

Type: void

clone()

Makes a duplicate copy of the Metadata.DeployContainer.

Signature

public Object clone()

Return Value

Type: Object

getMetadata()

Retrieves a list of custom metadata components from the container.

Signature

public List<Metadata.Metadata> getMetadata()

Return Value

Type: List<Metadata.Metadata>

removeMetadata(md)

Removes a metadata component from the container.

Signature

public Boolean removeMetadata(Metadata.Metadata md)

Parameters

Return Value

Type: Boolean

Returns true if the container changed as a result of the call.

removeMetadataByFullName(fullName)

Removes a metadata component from the container using the component’s full name.

Signature

public Boolean removeMetadataByFullName(String fullName)

Parameters

  • fullName:

    Type: String

    Full

    name of the component to remove.

Return Value

Type: Boolean

Returns true if the container changed as a result of the call.