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.

runSelectedMacro()

Executes the selected macro in the macro widget. This method is only available in API version 36.0 or later. This method isn’t supported in Lightning Console.

Syntax

1sforce.console.runSelectedMacro ((optional)callback:Function)

Arguments

Name	Type	Description
callback	function	JavaScript method that is called when the method is completed

Sample Code–Visualforce

1<apex:page>
2    <A HREF="#" onClick="executeInWidget();return false">Click here to run a macro</A>
3    <apex:includeScript value="/support/console/68.0/integration.js"/>
4    <script type="text/javascript">
5        function executeInWidget() {
6           sforce.console.runSelectedMacro();
7        }
8    </script>
9</apex:page>

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
cause	string	Explanation of function failure, if applicable
success	boolean	`true` if running the macro was successful; `false` otherwise

Salesforce Console Developer Guide

runSelectedMacro()

Syntax

Arguments

Sample Code–Visualforce

Response