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
CommercePayments Namespace
ConnectApi Namespace
Database Namespace
Datacloud Namespace
DataSource Namespace
DataWeave Namespace (Beta)
Dom Namespace
EventBus Namespace
ChangeEventHeader Class
EventPublishFailureCallback Interface
EventPublishSuccessCallback Interface
EventPublishSuccessCallback Methods
EventPublishSuccessCallback Example Implementation
FailureResult Interface
SuccessResult Interface
TestBroker Class
TriggerContext Class
ExternalService Namespace
Flow Namespace
Functions Namespace
Invocable Namespace
KbManagement Namespace
LxScheduler Namespace
Messaging Namespace
Metadata Namespace
Pref_center Namespace
Process Namespace
QuickAction Namespace
Reports Namespace
RichMessaging 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

EventPublishSuccessCallback Interface

Implement this interface to track platform event messages that were published successfully. The onSuccess() method in this interface is called when the final result of the asynchronous publish operation becomes available.

Namespace

EventBus

Usage

For more information, see <link>Get the Result of Asynchronous Platform Event Publishing with Apex Publish Callbacks<link/> in the Platform Events Developer Guide.

EventPublishSuccessCallback Methods

The following are methods for EventPublishSuccessCallback.

onSuccess(result)

The system invokes this method when the final result of EventBus.publish is available and the publishing of the platform event message succeeded.

Signature

public void onSuccess(eventbus.SuccessResult result)

Parameters

result
Type: EventBus.SuccessResult
The final result of EventBus.publish.

Return Value

Type: void

EventPublishSuccessCallback Example Implementation

For an example implementation and a test class, see <link>Get the Result of Asynchronous Platform Event Publishing with Apex Publish Callbacks<link/> in the Platform Events Developer Guide.