AJAX Toolkit Developer Guide

AJAX Toolkit Developer Guide
When to Use the AJAX Toolkit
Working with the AJAX Toolkit
API Calls and the AJAX Toolkit
Synchronous and Asynchronous Calls with the AJAX Toolkit
API Call Syntax in the AJAX Toolkit
Object Functions
Data Types in AJAX Toolkit
source Context Variable
Debugging with the AJAX Toolkit
Example Calls Using the Ajax Toolkit
SOAP Header Options with the AJAX Toolkit
Error Handling with the AJAX Toolkit
Advanced Topics
Glossary
PDF

Newer Version Available

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

API Call Syntax in the AJAX Toolkit

SOAP API calls use slightly different syntax in AJAX Toolkit, depending on whether the call is synchronous or asynchronous.

Synchronous Calls

Syntax:

1sforce.connection.method("arg1","arg2", ...);

Example:

1sforce.connection.login("MyName@MyOrg.com","myPassword1");

Asynchronous Calls

Syntax:

1method("arg1","arg2", ..., callback_method);

Example:

1var callback = {onSuccess: handleSuccess, onFailure: handleFailure};
2function handleSuccess(result) {}
3function handleFailure(error) {}
4sforce.connection.query("Select name from Account", callback);

In this example, onSuccess is the callback function, which will return the results when they are ready.

See Core Calls in the SOAP API Developer's Guide for call usage, arguments, and best practices, but use the AJAX Toolkit syntax for methods you embed in JavaScript.

Because delete is a JavaScript keyword, use deleteIds instead of the API call delete.

Note