Apex Developer Guide

Apex Developer Guide
Getting Started with Apex
Writing Apex
Running Apex
Invoking Apex
Anonymous Blocks
Triggers
Asynchronous Apex
Exposing Apex Methods as SOAP Web Services
Exposing Apex Classes as REST Web Services
Apex Email Service
Using the InboundEmail Object
Visualforce Classes
JavaScript Remoting
Apex in AJAX
Apex Transactions and Governor Limits
Using Salesforce Features with Apex
Integration and Apex Utilities
Debugging, Testing, and Deploying Apex
Apex Language Reference
Appendices
Glossary
PDF

Newer Version Available

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

Apex in AJAX

The AJAX toolkit includes built-in support for invoking Apex through anonymous blocks or public webservice methods.

To invoke Apex through anonymous blocks or public webservice methods, include the following lines in your AJAX code:

1<script src="/soap/ajax/42.0/connection.js" type="text/javascript"></script>
2<script src="/soap/ajax/42.0/apex.js" type="text/javascript"></script>

For AJAX buttons, use the alternate forms of these includes.

Note

To invoke Apex, use one of the following two methods:
  • Execute anonymously via sforce.apex.executeAnonymous (script). This method returns a result similar to the API's result type, but as a JavaScript structure.
  • Use a class WSDL. For example, you can call the following Apex class:
    1global class myClass { 
2  webservice static Id makeContact(String lastName, Account a) { 
3        Contact c = new Contact(LastName = lastName, AccountId = a.Id); 
4        return c.id; 
5    }
6}

    By using the following JavaScript code:

    1var account = sforce.sObject("Account");
2var id = sforce.apex.execute("myClass","makeContact",
3                             {lastName:"Smith",
4                              a:account});

    The execute method takes primitive data types, sObjects, and lists of primitives or sObjects.

    To call a webservice method with no parameters, use {} as the third parameter for sforce.apex.execute. For example, to call the following Apex class:

    1global class myClass{ 
2   webservice static String getContextUserName() {
3        return UserInfo.getFirstName();
4   }
5}

    Use the following JavaScript code:

    1var contextUser = sforce.apex.execute("myClass", "getContextUserName", {});

    If a namespace has been defined for your organization, you must include it in the JavaScript code when you invoke the class. For example, to call the above class, the JavaScript code from above would be rewritten as follows:

    1var contextUser = sforce.apex.execute("myNamespace.myClass", "getContextUserName", {});

    To verify whether your organization has a namespace, log in to your Salesforce organization and from Setup, enter Packages in the Quick Find box, then select Packages. If a namespace is defined, it is listed under Developer Settings.

    Note

    Both examples result in native JavaScript values that represent the return type of the methods.

Use the following line to display a popup window with debugging information:

1sforce.debug.trace=true;