JSDoc: Class: Connection

new Connection(optionsopt)

Connection class to keep the API session information and manage requests

Parameters:

Name Type Attributes Description

options

Object

Connection options

Properties

Name	Type	Attributes	Description
`oauth2`	OAuth2 \| Object	<optional>	OAuth2 instance or options to be passed to OAuth2 constructor
`logLevel`	String	<optional>	Output logging level (DEBUG\|INFO\|WARN\|ERROR\|FATAL)
`version`	String	<optional>	Salesforce API Version (without "v" prefix)
`maxRequest`	Number	<optional>	Max number of requests allowed in parallel call
`loginUrl`	String	<optional>	Salesforce Login Server URL (e.g. https://login.salesforce.com/)
`instanceUrl`	String	<optional>	Salesforce Instance URL (e.g. https://na1.salesforce.com/)
`serverUrl`	String	<optional>	Salesforce SOAP service endpoint URL (e.g. https://na1.salesforce.com/services/Soap/u/28.0)
`accessToken`	String	<optional>	Salesforce OAuth2 access token
`sessionId`	String	<optional>	Salesforce session ID
`refreshToken`	String	<optional>	Salesforce OAuth2 refresh token
`signedRequest`	String \| Object	<optional>	Salesforce Canvas signed request (Raw Base64 string, JSON string, or deserialized JSON)
`proxyUrl`	String	<optional>	Cross-domain proxy server URL, used in browser client, non Visualforce app.
`callOptions`	Object	<optional>	Call options used in each SOAP/REST API request. See manual.

Source:

connection.js, line 49

Extends

events.EventEmitter

Members

analytics :Analytics

Analytics API object

Type:

Analytics

Source:

connection.js, line 98

apex :Apex

Apex REST API object

Type:

Apex

Source:

connection.js, line 120

bulk :Bulk

Bulk API object

Type:

Bulk

Source:

connection.js, line 88

cache :Cache

Cache object for result

Type:

Cache

Source:

connection.js, line 131

chatter :Chatter

Chatter API object

Type:

Chatter

Source:

connection.js, line 103

metadata :Metadata

Metadata API object

Type:

Metadata

Source:

connection.js, line 108

oauth2 :OAuth2

OAuth2 object

Type:

OAuth2

Source:

connection.js, line 61

process :Process

Type:

Process

Source:

connection.js, line 126

soap :SoapApi

SOAP API object

Type:

SoapApi

Source:

connection.js, line 114

streaming :Streaming

Streaming API object

Type:

Streaming

Source:

connection.js, line 83

tooling :Tooling

Tooling API object

Type:

Tooling

Source:

connection.js, line 93

Methods

authorize(code, callbackopt) → {Promise.<UserInfo>}

Authorize (using oauth2 web server flow)

Parameters:

Name	Type	Attributes	Description
`code`	String		Authorization code
`callback`	Callback.<UserInfo>	<optional>	Callback function

Source:

connection.js, line 915

Returns:

Type: Promise.<UserInfo>

create(type, records, optionsopt, callbackopt) → {Promise.<(RecordResult|Array.<RecordResult>)>}

Create records

Parameters:

Name	Type	Attributes	Description
`type`	String		SObject Type
`records`	Record \| Array.<Record>		A record or array of records to create
`options`	Object	<optional>	Options for rest api.
`callback`	Callback.<(RecordResult\|Array.<RecordResult>)>	<optional>	Callback function

Source:

connection.js, line 568

Returns:

Type: Promise.<(RecordResult|Array.<RecordResult>)>

del(type, ids, optionsopt, callbackopt) → {Promise.<(RecordResult|Array.<RecordResult>)>}

Synonym of Connection#destroy()

Parameters:

Name	Type	Attributes	Description
`type`	String		SObject Type
`ids`	String \| Array.<String>		A ID or array of IDs to delete
`options`	Object	<optional>	Options for rest api.
`callback`	Callback.<(RecordResult\|Array.<RecordResult>)>	<optional>	Callback

Source:

connection.js, line 754

Returns:

Type: Promise.<(RecordResult|Array.<RecordResult>)>

delete(type, ids, optionsopt, callbackopt) → {Promise.<(RecordResult|Array.<RecordResult>)>}

Synonym of Connection#destroy()

Parameters:

Name	Type	Attributes	Description
`type`	String		SObject Type
`ids`	String \| Array.<String>		A ID or array of IDs to delete
`options`	Object	<optional>	Options for rest api.
`callback`	Callback.<(RecordResult\|Array.<RecordResult>)>	<optional>	Callback

Source:

connection.js, line 744

Returns:

Type: Promise.<(RecordResult|Array.<RecordResult>)>

deleted(type, start, end, callbackopt) → {Promise.<DeletedRecordsInfo>}

Retrieve deleted records

Parameters:

Name	Type	Attributes	Description
`type`	String		SObject Type
`start`	String \| Date		start date or string representing the start of the interval
`end`	String \| Date		start date or string representing the end of the interval
`callback`	Callback.<DeletedRecordsInfo>	<optional>	Callback function

Source:

connection.js, line 1253

Returns:

Type: Promise.<DeletedRecordsInfo>

describe(type, callbackopt) → {Promise.<DescribeSObjectResult>}

Describe SObject metadata

Parameters:

Name	Type	Attributes	Description
`type`	String		SObject Type
`callback`	Callback.<DescribeSObjectResult>	<optional>	Callback function

Source:

connection.js, line 829

Returns:

Type: Promise.<DescribeSObjectResult>

describeGlobal(callbackopt) → {Promise.<DescribeGlobalResult>}

Describe global SObjects

Parameters:

Name	Type	Attributes	Description
`callback`	Callback.<DescribeGlobalResult>	<optional>	Callback function

Source:

connection.js, line 855

Returns:

Type: Promise.<DescribeGlobalResult>

describeSObject(type, callbackopt) → {Promise.<DescribeSObjectResult>}

Synonym of Connection#describe()

Parameters:

Name	Type	Attributes	Description
`type`	String		SObject Type
`callback`	Callback.<DescribeSObjectResult>	<optional>	Callback function

Source:

connection.js, line 821

Returns:

Type: Promise.<DescribeSObjectResult>

destroy(type, ids, optionsopt, callbackopt) → {Promise.<(RecordResult|Array.<RecordResult>)>}

Delete records

Parameters:

Name	Type	Attributes	Description
`type`	String		SObject Type
`ids`	String \| Array.<String>		A ID or array of IDs to delete
`options`	Object	<optional>	Options for rest api.
`callback`	Callback.<(RecordResult\|Array.<RecordResult>)>	<optional>	Callback

Source:

connection.js, line 764

Returns:

Type: Promise.<(RecordResult|Array.<RecordResult>)>

identity(callbackopt) → {Promise.<IdentityInfo>}

Get identity information of current user

Parameters:

Name	Type	Attributes	Description
`callback`	Callback.<IdentityInfo>	<optional>	Callback function

Source:

connection.js, line 880

Returns:

Type: Promise.<IdentityInfo>

(protected) initialize(options)

Initialize connection.

Parameters:

Name Type Description

options

Object

Initialization options

Properties

Name	Type	Attributes	Description
`instanceUrl`	String	<optional>	Salesforce Instance URL (e.g. https://na1.salesforce.com/)
`serverUrl`	String	<optional>	Salesforce SOAP service endpoint URL (e.g. https://na1.salesforce.com/services/Soap/u/28.0)
`accessToken`	String	<optional>	Salesforce OAuth2 access token
`sessionId`	String	<optional>	Salesforce session ID
`refreshToken`	String	<optional>	Salesforce OAuth2 refresh token
`signedRequest`	String \| Object	<optional>	Salesforce Canvas signed request (Raw Base64 string, JSON string, or deserialized JSON)
`userInfo`	UserInfo	<optional>	Logged in user information

Source:

connection.js, line 177

insert(type, records, callbackopt) → {Promise.<(RecordResult|Array.<RecordResult>)>}

Synonym of Connection#create()

Parameters:

Name	Type	Attributes	Description
`type`	String		SObject Type
`records`	Object \| Array.<Object>		A record or array of records to create
`callback`	Callback.<(RecordResult\|Array.<RecordResult>)>	<optional>	Callback function

Source:

connection.js, line 559

Returns:

Type: Promise.<(RecordResult|Array.<RecordResult>)>

limits(callbackopt) → {Promise.<LimitsInfo>}

Returns curren system limit in the organization

Parameters:

Name	Type	Attributes	Description
`callback`	Callback.<LimitsInfo>	<optional>	Callback function

Source:

connection.js, line 1310

Returns:

Type: Promise.<LimitsInfo>

Parameters:

Name	Type	Attributes	Description
`username`	String		Salesforce username
`password`	String		Salesforce password (and security token, if required)
`callback`	Callback.<UserInfo>	<optional>	Callback function

Source:

connection.js, line 944

Returns:

Type: Promise.<UserInfo>

loginByOAuth2(username, password, callbackopt) → {Promise.<UserInfo>}

Parameters:

Name	Type	Attributes	Description
`username`	String		Salesforce username
`password`	String		Salesforce password (and security token, if required)
`callback`	Callback.<UserInfo>	<optional>	Callback function

Source:

connection.js, line 972

Returns:

Type: Promise.<UserInfo>

loginBySoap(username, password, callbackopt) → {Promise.<UserInfo>}

Parameters:

Name	Type	Attributes	Description
`username`	String		Salesforce username
`password`	String		Salesforce password (and security token, if required)
`callback`	Callback.<UserInfo>	<optional>	Callback function

Source:

connection.js, line 1006

Returns:

Type: Promise.<UserInfo>

logout(callbackopt) → {Promise.<undefined>}

Logout the current session

Parameters:

Name	Type	Attributes	Description
`callback`	Callback.<undefined>	<optional>	Callback function

Source:

connection.js, line 1072

Returns:

Type: Promise.<undefined>

logoutByOAuth2(callbackopt) → {Promise.<undefined>}

Logout the current session by revoking access token via OAuth2 session revoke

Parameters:

Name	Type	Attributes	Description
`callback`	Callback.<undefined>	<optional>	Callback function

Source:

connection.js, line 1086

Returns:

Type: Promise.<undefined>

logoutBySoap(callbackopt) → {Promise.<undefined>}

Logout the session by using SOAP web service API

Parameters:

Name	Type	Attributes	Description
`callback`	Callback.<undefined>	<optional>	Callback function

Source:

connection.js, line 1110

Returns:

Type: Promise.<undefined>

query(soql, callbackopt) → {Query.<QueryResult>}

Execute query by using SOQL

Parameters:

Name	Type	Attributes	Description
`soql`	String		SOQL string
`callback`	Callback.<QueryResult>	<optional>	Callback function

Source:

connection.js, line 481

Returns:

Type: Query.<QueryResult>

queryAll(soql, callbackopt) → {Query.<QueryResult>}

Execute query by using SOQL, including deleted records

Parameters:

Name	Type	Attributes	Description
`soql`	String		SOQL string
`callback`	Callback.<QueryResult>	<optional>	Callback function

Source:

connection.js, line 496

Returns:

Type: Query.<QueryResult>

queryMore(locator, callbackopt) → {Query.<QueryResult>}

Query next record set by using query locator

Parameters:

Name	Type	Attributes	Description
`locator`	String		Next record set locator
`callback`	Callback.<QueryResult>	<optional>	Callback function

Source:

connection.js, line 512

Returns:

Type: Query.<QueryResult>

quickAction(actionName) → {QuickAction}

Get reference for specified global quick aciton

Parameters:

Name	Type	Description
`actionName`	String	Name of the global quick action

Source:

connection.js, line 1347

Returns:

Type: QuickAction

quickActions(callbackopt) → {Promise.<Array.<QuickAction~QuickActionInfo>>}

Returns all registered global quick actions

Parameters:

Name	Type	Attributes	Description
`callback`	Callback.<Array.<QuickAction~QuickActionInfo>>	<optional>	Callback function

Source:

connection.js, line 1337

Returns:

Type: Promise.<Array.<QuickAction~QuickActionInfo>>

recent(typeopt, limitopt, callbackopt) → {Promise.<Array.<RecordResult>>}

List recently viewed records

Parameters:

Name	Type	Attributes	Description
`type`	String	<optional>	SObject type
`limit`	Number	<optional>	Limit num to fetch
`callback`	Callback.<Array.<RecordResult>>	<optional>	Callback function

Source:

connection.js, line 1164

Returns:

Type: Promise.<Array.<RecordResult>>

request(request, optionsopt, callbackopt) → {Promise.<Object>}

Send REST API request with given HTTP request info, with connected session information. Endpoint URL can be absolute URL ('https://na1.salesforce.com/services/data/v32.0/sobjects/Account/describe') , relative path from root ('/services/data/v32.0/sobjects/Account/describe') , or relative path from version root ('/sobjects/Account/describe').

Parameters:

Name Type Attributes Description

request

String | Object

HTTP request object or URL to GET request

Properties

Name	Type	Attributes	Description
`method`	String		HTTP method URL to send HTTP request
`url`	String		URL to send HTTP request
`headers`	Object	<optional>	HTTP request headers in hash object (key-value)

options Object <optional> HTTP API request options

callback Callback.<Object> <optional> Callback function

Source:

connection.js, line 283

Returns:

Type: Promise.<Object>

requestDelete(url, optionsopt, callbackopt) → {Promise.<Object>}

Send HTTP DELETE request Endpoint URL can be absolute URL ('https://na1.salesforce.com/services/data/v32.0/sobjects/Account/describe') , relative path from root ('/services/data/v32.0/sobjects/Account/describe') , or relative path from version root ('/sobjects/Account/describe').

Parameters:

Name	Type	Attributes	Description
`url`	String		Endpoint URL to request HTTP DELETE
`options`	Object	<optional>	HTTP API request options
`callback`	Callback.<Object>	<optional>	Callback function

Source:

connection.js, line 419

Returns:

Type: Promise.<Object>

requestGet(url, optionsopt, callbackopt) → {Promise.<Object>}

Send HTTP GET request Endpoint URL can be absolute URL ('https://na1.salesforce.com/services/data/v32.0/sobjects/Account/describe') , relative path from root ('/services/data/v32.0/sobjects/Account/describe') , or relative path from version root ('/sobjects/Account/describe').

Parameters:

Name	Type	Attributes	Description
`url`	String		Endpoint URL to request HTTP GET
`options`	Object	<optional>	HTTP API request options
`callback`	Callback.<Object>	<optional>	Callback function

Source:

connection.js, line 329

Returns:

Type: Promise.<Object>

requestPatch(url, body, optionsopt, callbackopt) → {Promise.<Object>}

Send HTTP PATCH request with JSON body Endpoint URL can be absolute URL ('https://na1.salesforce.com/services/data/v32.0/sobjects/Account/describe') , relative path from root ('/services/data/v32.0/sobjects/Account/describe') , or relative path from version root ('/sobjects/Account/describe').

Parameters:

Name	Type	Attributes	Description
`url`	String		Endpoint URL to request HTTP PATCH
`body`	Object		Any JS object which can be serialized to JSON
`options`	Object	<optional>	HTTP API request options
`callback`	Callback.<Object>	<optional>	Callback function

Source:

connection.js, line 397

Returns:

Type: Promise.<Object>

requestPost(url, body, optionsopt, callbackopt) → {Promise.<Object>}

Send HTTP POST request with JSON body, with connected session information Endpoint URL can be absolute URL ('https://na1.salesforce.com/services/data/v32.0/sobjects/Account/describe') , relative path from root ('/services/data/v32.0/sobjects/Account/describe') , or relative path from version root ('/sobjects/Account/describe').

Parameters:

Name	Type	Attributes	Description
`url`	String		Endpoint URL to request HTTP POST
`body`	Object		Any JS object which can be serialized to JSON
`options`	Object	<optional>	HTTP API request options
`callback`	Callback.<Object>	<optional>	Callback function

Source:

connection.js, line 351

Returns:

Type: Promise.<Object>

requestPut(url, body, optionsopt, callbackopt) → {Promise.<Object>}

Send HTTP PUT request with JSON body, with connected session information Endpoint URL can be absolute URL ('https://na1.salesforce.com/services/data/v32.0/sobjects/Account/describe') , relative path from root ('/services/data/v32.0/sobjects/Account/describe') , or relative path from version root ('/sobjects/Account/describe').

Parameters:

Name	Type	Attributes	Description
`url`	String		Endpoint URL to request HTTP PUT
`body`	Object		Any JS object which can be serialized to JSON
`options`	Object	<optional>	HTTP API request options
`callback`	Callback.<Object>	<optional>	Callback function

Source:

connection.js, line 374

Returns:

Type: Promise.<Object>

retrieve(type, ids, optionsopt, callbackopt) → {Promise.<(Record|Array.<Record>)>}

Retrieve specified records

Parameters:

Name	Type	Attributes	Description
`type`	String		SObject Type
`ids`	String \| Array.<String>		A record ID or array of record IDs
`options`	Object	<optional>	Options for rest api.
`callback`	Callback.<(Record\|Array.<Record>)>	<optional>	Callback function

Source:

connection.js, line 529

Returns:

Type: Promise.<(Record|Array.<Record>)>

search(sosl, callbackopt) → {Promise.<Array.<RecordResult>>}

Execute search by SOSL

Parameters:

Name	Type	Attributes	Description
`sosl`	String		SOSL string
`callback`	Callback.<Array.<RecordResult>>	<optional>	Callback function

Source:

connection.js, line 811

Returns:

Type: Promise.<Array.<RecordResult>>

sobject(type) → {SObject}

Get SObject instance

Parameters:

Name	Type	Description
`type`	String	SObject Type

Source:

connection.js, line 867

Returns:

Type: SObject

tabs(callbackopt) → {Promise.<TabsInfo>}

Returns a list of all tabs

Parameters:

Name	Type	Attributes	Description
`callback`	Callback.<TabsInfo>	<optional>	Callback function

Source:

connection.js, line 1294

Returns:

Type: Promise.<TabsInfo>

theme(callbackopt) → {Promise.<ThemeInfo>}

Returns a theme info

Parameters:

Name	Type	Attributes	Description
`callback`	Callback.<ThemeInfo>	<optional>	Callback function

Source:

connection.js, line 1326

Returns:

Type: Promise.<ThemeInfo>

update(type, records, optionsopt, callbackopt) → {Promise.<(RecordResult|Array.<RecordResult>)>}

Update records

Parameters:

Name	Type	Attributes	Description
`type`	String		SObject Type
`records`	Record \| Array.<Record>		A record or array of records to update
`options`	Object	<optional>	Options for rest api.
`callback`	Callback.<(RecordResult\|Array.<RecordResult>)>	<optional>	Callback function

Source:

connection.js, line 633

Returns:

Type: Promise.<(RecordResult|Array.<RecordResult>)>

updated(type, start, end, callbackopt) → {Promise.<UpdatedRecordsInfo>}

Retrieve updated records

Parameters:

Name	Type	Attributes	Description
`type`	String		SObject Type
`start`	String \| Date		start date or string representing the start of the interval
`end`	String \| Date		start date or string representing the end of the interval must be > start
`callback`	Callback.<UpdatedRecordsInfo>	<optional>	Callback function

Source:

connection.js, line 1205

Returns:

Type: Promise.<UpdatedRecordsInfo>

upsert(type, records, extIdField, optionsopt, callbackopt) → {Promise.<(RecordResult|Array.<RecordResult>)>}

Upsert records

Parameters:

Name	Type	Attributes	Description
`type`	String		SObject Type
`records`	Record \| Array.<Record>		Record or array of records to upsert
`extIdField`	String		External ID field name
`options`	Object	<optional>	Options for rest api.
`callback`	Callback.<(RecordResult\|Array.<RecordResult>)>	<optional>	Callback

Source:

connection.js, line 694

Returns:

Type: Promise.<(RecordResult|Array.<RecordResult>)>

Class: Connection

new Connection(optionsopt)

Parameters:

Properties

Extends

Members

analytics :Analytics

Type:

apex :Apex

Type:

bulk :Bulk

Type:

cache :Cache

Type:

chatter :Chatter

Type:

metadata :Metadata

Type:

oauth2 :OAuth2

Type:

process :Process

Type:

soap :SoapApi

Type:

streaming :Streaming

Type:

tooling :Tooling

Type:

Methods

authorize(code, callbackopt) → {Promise.<UserInfo>}

Parameters:

Returns:

create(type, records, optionsopt, callbackopt) → {Promise.<(RecordResult|Array.<RecordResult>)>}

Parameters:

Returns:

del(type, ids, optionsopt, callbackopt) → {Promise.<(RecordResult|Array.<RecordResult>)>}

Parameters:

Returns:

delete(type, ids, optionsopt, callbackopt) → {Promise.<(RecordResult|Array.<RecordResult>)>}

Parameters:

Returns:

deleted(type, start, end, callbackopt) → {Promise.<DeletedRecordsInfo>}

Parameters:

Returns:

describe(type, callbackopt) → {Promise.<DescribeSObjectResult>}

Parameters:

Returns:

describeGlobal(callbackopt) → {Promise.<DescribeGlobalResult>}

Parameters:

Returns:

describeSObject(type, callbackopt) → {Promise.<DescribeSObjectResult>}

Parameters:

Returns:

destroy(type, ids, optionsopt, callbackopt) → {Promise.<(RecordResult|Array.<RecordResult>)>}

Parameters:

Returns:

identity(callbackopt) → {Promise.<IdentityInfo>}

Parameters:

Returns:

(protected) initialize(options)

Parameters:

Properties

insert(type, records, callbackopt) → {Promise.<(RecordResult|Array.<RecordResult>)>}

Parameters:

Returns:

limits(callbackopt) → {Promise.<LimitsInfo>}

Parameters:

Returns:

login(username, password, callbackopt) → {Promise.<UserInfo>}

Parameters:

Returns:

loginByOAuth2(username, password, callbackopt) → {Promise.<UserInfo>}

Parameters:

Returns:

loginBySoap(username, password, callbackopt) → {Promise.<UserInfo>}

Parameters:

Returns:

logout(callbackopt) → {Promise.<undefined>}

Parameters:

Returns: