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
DeployDetails Class
DeployMessage Class
DeployMessage Properties
DeployMessage Methods
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.

DeployMessage Class

Represents result information for the deployment of a metadata component.

Namespace

Metadata

Usage

Use DeployMessage to access detailed information about component deployments. Salesforce provides a list of DeployMessages for a completed deployment via the DeployDetails and DeployResults instances sent in the DeployCallback.handleResult() callback.

DeployMessage Properties

The following are properties for DeployMessage.

changed

Determines whether the component was changed after deployment. If true, the component was changed as a result of the deployment. If false, the deployed component was the same as the corresponding component already in the org.

Signature

public Boolean changed {get; set;}

Property Value

Type: Boolean

columnNumber

Each component is represented by a text file. If an error occurs during deployment, this property represents the column of the text file where the error occurred.

Signature

public Integer columnNumber {get; set;}

Property Value

Type: Integer

componentType

The metadata type of the component in the deployment.

Signature

public String componentType {get; set;}

Property Value

Type: String

created

If true, the component was created as a result of the deployment. If false, the component was modified as a result of the deployment.

Signature

public Boolean created {get; set;}

Property Value

Type: Boolean

createdDate

The date and time when the component was created as a result of the deployment.

Signature

public Datetime createdDate {get; set;}

Property Value

Type: Datetime

deleted

If true, the component was deleted as a result of the deployment. If false, the component was either new or modified as result of the deployment.

Signature

public Boolean deleted {get; set;}

Property Value

Type: Boolean

fileName

The name of the file in the metadata archive used to deploy the component.

Signature

public String fileName {get; set;}

Property Value

Type: String

fullName

Full name for the custom metadata component.

Signature

public String fullName {get; set;}

Property Value

Type: String

id

ID of the component that was deployed.

Signature

public Id id {get; set;}

Property Value

Type: Id

lineNumber

Each component is represented by a text file. If an error occurs during deployment, this field represents the line number of the text file where the error occurred.

Signature

public Integer lineNumber {get; set;}

Property Value

Type: Integer

problem

If an error or warning occurred, this field contains a description of the problem that caused the deployment to fail.

Signature

public String problem {get; set;}

Property Value

Type: String

problemType

Indicates the problem type, for example, an error or warning.

Signature

public Metadata.DeployProblemType problemType {get; set;}

Property Value

Type: Metadata.DeployProblemType

success

Indicates whether the component was successfully deployed (true) or not (false).

Signature

public Boolean success {get; set;}

Property Value

Type: Boolean

DeployMessage Methods

The following are methods for DeployMessage.

clone()

Makes a duplicate copy of the Metadata.DeployMessage.

Signature

public Object clone()

Return Value

Type: Object