Newer Version Available

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

fireEvent()

Fires a custom event. This method is only available in API version 25.0 or later.

Syntax

Arguments

Name Type Description
eventType string The type of custom event to fire.
message string The message which is sent with the fired event.
callback function JavaScript method called when the custom event is fired.

Sample Code–Visualforce

Response

This method is asynchronous, so it returns its response in an object in a callback method. The response object contains the following field:

Name Type Description
success boolean true if firing the event is successful, false if firing the event wasn’t successful.