Global

Type Definitions

Callback(err, response)

Parameters:
Name Type Description
err Error Callback error
response T Callback response
Source:

DeletedRecordsInfo

Type:
  • Object
Properties:
Name Type Description
earliestDateAvailable String The timestamp of the earliest date available
latestDateCovered String The timestamp of the last date covered
deletedRecords Array.<Object> Updated records
Properties
Name Type Description
id String Record ID
deletedDate String The timestamp when this record was deleted
Source:

DescribeGlobalResult

Result returned by describeGlobal call
Type:
  • Object
Source:

DescribeSObjectResult

Result returned by describeSObject call
Type:
  • Object
Source:

FulfilledCallback(result) → {S}

Parameters:
Name Type Description
result T Fulfilled value
Source:
Returns:
Type
S

QueryResult

Type:
  • Object
Properties:
Name Type Argument Description
done Boolean Flag if the query is fetched all records or not
nextRecordsUrl String <optional>
 URL locator for next record set, (available when done = false)
totalSize Number Total size for query
records Array.<Record> <optional>
 Array of records fetched
Source:

Record

A simple hash object including record field information
Type:
  • Object
Source:

RecordFilterFunction(record) → {Boolean}

Parameters:
Name Type Description
record Record Source record to filter
Source:
Returns:
Type
Boolean

RecordMapFunction(record) → {Record}

Parameters:
Name Type Description
record Record Source record to map
Source:
Returns:
Type
Record

RecordResult

Properties:
Name Type Argument Description
success Boolean The result is succeessful or not
id String <optional>
 Record ID
errors Array.<String> <optional>
 Errors (available when success = false)
Source:

RejectedCallback(reason) → {S}

Parameters:
Name Type Description
reason Error Rejected reason
Source:
Returns:
Type
S

TokenResponse

Type:
  • Object
Properties:
Name Type Description
access_token String
refresh_token String
Source:

UpdatedRecordsInfo

Type:
  • Object
Properties:
Name Type Description
latestDateCovered String The timestamp of the last date covered.
ids Array.<String> Updated record IDs.
Source:

UserInfo

Properties:
Name Type Description
id String User ID
organizationId String Organization ID
url String Identity URL of the user
Source: