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
DeployProblemType Enum
DeployResult Class
DeployResult Properties
DeployResult Methods
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.

DeployResult Class

Represents the results of a metadata deployment.

Namespace

Metadata

Usage

After an asynchronous metadata deployment finishes, Salesforce provides an instance of Metadata.DeployResult in a call to your implementation of handleResult() in your Metadata.DeployCallback class.

Example

1public void handleResult(Metadata.DeployResult result,
2                         Metadata.DeployCallbackContext context) {
3    if (result.status == Metadata.DeployStatus.Succeeded) {
4        // Deployment was successful
5    } else {
6        // Deployment was not successful
7    }
8}

DeployResult Properties

The following are properties for DeployResult.

canceledBy

ID of the user who canceled the queued deployment.

Signature

public String canceledBy {get; set;}

Property Value

Type: String

canceledByName

Full name of the user who canceled the queued deployment.

Signature

public String canceledByName {get; set;}

Property Value

Type: String

checkOnly

Indicates whether the deployment checked only the validity of the deployed files without making changes in the org. A check-only deployment does not deploy components or change the org in any way.

Signature

public Boolean checkOnly {get; set;}

Property Value

Type: Boolean

completedDate

Date and time for when the deployment process ended.

Signature

public Datetime completedDate {get; set;}

Property Value

Type: Datetime

createdBy

ID of the user who created the deployment job.

Signature

public String createdBy {get; set;}

Property Value

Type: String

createdByName

Full name of the user who created the deployment job.

Signature

public String createdByName {get; set;}

Property Value

Type: String

createdDate

Date and time the deployment job was first queued.

Signature

public Datetime createdDate {get; set;}

Property Value

Type: Datetime

details

Provides the details for components in a completed deployment.

Signature

public Metadata.DeployDetails details {get; set;}

Property Value

Type: Metadata.DeployDetails

done

Indicates whether Salesforce finished processing the deployment.

Signature

public Boolean done {get; set;}

Property Value

Type: Boolean

errorMessage

Message corresponding to the values in the errorStatusCode property, if any.

Signature

public String errorMessage {get; set;}

Property Value

Type: String

errorStatusCode

If an error occurs during deployment, a status code is returned. The message corresponding to the status code is returned in the errorMessagefield property.

Signature

public String errorStatusCode {get; set;}

Property Value

Type: String

For a description of each status code value, see Core Data Types Used in API Calls in the SOAP API Developer Guide.

id

ID of the deployment job.

Signature

public Id id {get; set;}

Property Value

Type: Id

ignoreWarnings

Specifies whether a deployment continues, even if the deployment generates warnings.

Signature

public Boolean ignoreWarnings {get; set;}

Property Value

Type: Boolean

lastModifiedDate

Date and time of the last update for the deployment process.

Signature

public Datetime lastModifiedDate {get; set;}

Property Value

Type: Datetime

messages

A list of all the detail messages for a deployment.

Signature

Removed in API version 29.0 and later.

Note

public List<Metadata.DeployMessage> messages {get; set;}

Property Value

Type: List<Metadata.DeployMessage>

numberComponentErrors

The number of components that generated errors during the deployment.

Signature

public Integer numberComponentErrors {get; set;}

Property Value

Type: Integer

numberComponentsDeployed

The number of components deployed in the deployment process. Use this value with the numberComponentsTotal property to get an estimate of the deployment’s progress.

Signature

public Integer numberComponentsDeployed {get; set;}

Property Value

Type: Integer

numberComponentsTotal

The total number of components in the deployment. Use this value with the numberComponentsDeployed property to get an estimate of the deployment’s progress.

Signature

public Integer numberComponentsTotal {get; set;}

Property Value

Type: Integer

rollbackOnError

Indicates whether any failure causes a complete rollback (true) or not (false) of the deployment.

Signature

public Boolean rollbackOnError {get; set;}

Property Value

Type: Boolean

startDate

Date and time the deployment process began.

Signature

public Datetime startDate {get; set;}

Property Value

Type: Datetime

stateDetail

Indicates which component is being deployed.

Signature

public String stateDetail {get; set;}

Property Value

Type: String

status

Indicates the current state of the deployment.

Signature

public Metadata.DeployStatus status {get; set;}

Property Value

Type: Metadata.DeployStatus

success

Indicates whether the deployment was successful (true) or not (false).

Signature

public Boolean success {get; set;}

Property Value

Type: Boolean

DeployResult Methods

The following are methods for DeployResult.

clone()

Makes a duplicate copy of the Metadata.DeployResult.

Signature

public Object clone()

Return Value

Type: Object