Apex Reference Guide

Apex Reference Guide
Apex DML Operations
ApexPages Namespace
AppLauncher Namespace
Approval Namespace
Auth Namespace
Cache Namespace
Canvas Namespace
ChatterAnswers Namespace
CommercePayments Namespace
ConnectApi Namespace
Database Namespace
Datacloud Namespace
DataSource Namespace
Dom Namespace
EventBus Namespace
ExternalService Namespace
Flow Namespace
Functions Namespace
KbManagement Namespace
LxScheduler Namespace
Messaging Namespace
Metadata Namespace
AnalyticsCloudComponentLayoutItem Class
ConsoleComponent Class
Container Class
CustomConsoleComponents Class
CustomMetadata Class
CustomMetadataValue Class
DeployCallback Interface
DeployCallback Methods
DeployCallback Example Implementation
DeployCallbackContext Class
DeployContainer Class
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
Pref_center Namespace
Process Namespace
QuickAction Namespace
Reports Namespace
Schema Namespace
Search Namespace
Sfc Namespace
Sfdc_Checkout Namespace
sfdc_surveys Namespace
Site Namespace
Support Namespace
System Namespace
TerritoryMgmt Namespace
TxnSecurity Namespace
UserProvisioning Namespace
VisualEditor Namespace
Wave Namespace
Appendices
PDF

Newer Version Available

This content describes an older version of this product. View Latest

DeployCallback Interface

An interface for metadata deployment callback classes.

Namespace

Metadata

Usage

You must provide a callback class for the asynchronous deployment of custom metadata through Apex. This class must implement the Metadata.DeployCallback interface.

Salesforce calls your DeployCallback.handleResult() method asynchronously once the queued deployment completes. Because the callback is called as asynchronous Apex after deployment, there may be a brief period where the deploy has completed, but your callback has not been called yet.

DeployCallback Methods

The following are methods for DeployCallback.

handleResult(var1, var2)

Method that is called when the asynchronous deployment of custom metadata completes.

Signature

public void handleResult(Metadata.DeployResult var1, Metadata.DeployCallbackContext var2)

Parameters

var1
Type: Metadata.DeployResult
The results of the asynchronous deployment.
var2
Type: Metadata.DeployCallbackContext
The context for the queued asynchronous deployment job.

Return Value

Type: void

DeployCallback Example Implementation

This is an example implementation of the Metadata.DeployCallback interface.

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

The following example uses this implementation for a deployment.

1// Setup callback and deploy
2MyCallback callback = new MyCallback();
3Metadata.Operations.enqueueDeployment(mdContainer, callback);