api documentation for jsforce (v1.7.2)

Salesforce API Library for JavaScript

table of contents

  1. module jsforce
    1. function jsforce.cache ()
    2. function jsforce.date (literal)
    3. function jsforce.http_api (conn, options)
    4. function jsforce.logger (logLevel)
    5. function jsforce.promise (fn)
    6. function jsforce.query (conn, config, options)
    7. function jsforce.quick_action (conn, path)
    8. function jsforce.record (conn, type, id)
    9. function jsforce.record_stream ()
    10. function jsforce.soap (conn, options)
    11. function jsforce.sobject (conn, type)
    12. object jsforce.cache.prototype
    13. object jsforce.canvas
    14. object jsforce.csv
    15. object jsforce.date.prototype
    16. object jsforce.http_api.prototype
    17. object jsforce.jsonp
    18. object jsforce.logger.prototype
    19. object jsforce.promise.prototype
    20. object jsforce.query.prototype
    21. object jsforce.quick_action.prototype
    22. object jsforce.record.prototype
    23. object jsforce.record_stream.prototype
    24. object jsforce.soap.prototype
    25. object jsforce.sobject.prototype
    26. object jsforce.soql_builder
  2. module jsforce.cache
    1. function jsforce.cache ()
  3. module jsforce.cache.prototype
    1. function jsforce.cache.prototype.clear (key)
    2. function jsforce.cache.prototype.get (key)
    3. function jsforce.cache.prototype.makeCacheable (fn, scope, options)
    4. function jsforce.cache.prototype.makeResponseCacheable (fn, scope, options)
  4. module jsforce.canvas
    1. boolean jsforce.canvas.supported
    2. function jsforce.canvas.createRequest (signedRequest)
  5. module jsforce.csv
    1. function jsforce.csv.parseCSV (str, options)
    2. function jsforce.csv.parseCSVStream (options)
    3. function jsforce.csv.serializeCSVStream (options)
    4. function jsforce.csv.toCSV (records, options)
  6. module jsforce.date
    1. function jsforce.date (literal)
    2. function jsforce.date.LAST_N_DAYS (num)
    3. function jsforce.date.LAST_N_FISCAL_QUARTERS (num)
    4. function jsforce.date.LAST_N_FISCAL_YEARS (num)
    5. function jsforce.date.LAST_N_MONTHS (num)
    6. function jsforce.date.LAST_N_QUARTERS (num)
    7. function jsforce.date.LAST_N_WEEKS (num)
    8. function jsforce.date.LAST_N_YEARS (num)
    9. function jsforce.date.NEXT_N_DAYS (num)
    10. function jsforce.date.NEXT_N_FISCAL_QUARTERS (num)
    11. function jsforce.date.NEXT_N_FISCAL_YEARS (num)
    12. function jsforce.date.NEXT_N_MONTHS (num)
    13. function jsforce.date.NEXT_N_QUARTERS (num)
    14. function jsforce.date.NEXT_N_WEEKS (num)
    15. function jsforce.date.NEXT_N_YEARS (num)
    16. function jsforce.date.parseDate (str)
    17. function jsforce.date.toDateLiteral (date)
    18. function jsforce.date.toDateTimeLiteral (date)
    19. object jsforce.date.LAST_90_DAYS
    20. object jsforce.date.LAST_FISCAL_QUARTER
    21. object jsforce.date.LAST_FISCAL_YEAR
    22. object jsforce.date.LAST_MONTH
    23. object jsforce.date.LAST_QUARTER
    24. object jsforce.date.LAST_WEEK
    25. object jsforce.date.LAST_YEAR
    26. object jsforce.date.NEXT_90_DAYS
    27. object jsforce.date.NEXT_FISCAL_QUARTER
    28. object jsforce.date.NEXT_FISCAL_YEAR
    29. object jsforce.date.NEXT_MONTH
    30. object jsforce.date.NEXT_QUARTER
    31. object jsforce.date.NEXT_WEEK
    32. object jsforce.date.NEXT_YEAR
    33. object jsforce.date.THIS_FISCAL_QUARTER
    34. object jsforce.date.THIS_FISCAL_YEAR
    35. object jsforce.date.THIS_MONTH
    36. object jsforce.date.THIS_QUARTER
    37. object jsforce.date.THIS_WEEK
    38. object jsforce.date.THIS_YEAR
    39. object jsforce.date.TODAY
    40. object jsforce.date.TOMORROW
    41. object jsforce.date.YESTERDAY
  7. module jsforce.date.prototype
    1. function jsforce.date.prototype.toJSON ()
    2. function jsforce.date.prototype.toString ()
  8. module jsforce.http_api
    1. function jsforce.http_api (conn, options)
    2. function jsforce.http_api.SessionRefreshDelegate (conn, refreshFn)
    3. function jsforce.http_api.super_ ()
  9. module jsforce.http_api.prototype
    1. function jsforce.http_api.prototype.beforeSend (request)
    2. function jsforce.http_api.prototype.getError (response, body)
    3. function jsforce.http_api.prototype.getRefreshDelegate ()
    4. function jsforce.http_api.prototype.getResponseBody (response)
    5. function jsforce.http_api.prototype.getResponseContentType (response)
    6. function jsforce.http_api.prototype.hasErrorInResponseBody (body)
    7. function jsforce.http_api.prototype.isErrorResponse (response)
    8. function jsforce.http_api.prototype.isSessionExpired (response)
    9. function jsforce.http_api.prototype.parseError (body)
    10. function jsforce.http_api.prototype.parseResponseBody (response)
    11. function jsforce.http_api.prototype.request (request, callback)
  10. module jsforce.jsonp
    1. boolean jsforce.jsonp.supported
    2. function jsforce.jsonp.createRequest (jsonpParam, timeout)
  11. module jsforce.logger
    1. function jsforce.logger (logLevel)
    2. object jsforce.logger.LogLevels
  12. module jsforce.logger.prototype
    1. function jsforce.logger.prototype.debug (message)
    2. function jsforce.logger.prototype.error (message)
    3. function jsforce.logger.prototype.fatal (message)
    4. function jsforce.logger.prototype.info (message)
    5. function jsforce.logger.prototype.log (level, message)
    6. function jsforce.logger.prototype.warn (message)
  13. module jsforce.promise
    1. function jsforce.promise (fn)
    2. function jsforce.promise._61 ()
    3. function jsforce.promise.all (arr)
    4. function jsforce.promise.defer ()
    5. function jsforce.promise.race (values)
    6. function jsforce.promise.reject (value)
    7. function jsforce.promise.resolve (value)
    8. object jsforce.promise._10
    9. object jsforce.promise._97
  14. module jsforce.promise.prototype
    1. function jsforce.promise.prototype.catch (onRejected)
    2. function jsforce.promise.prototype.fail (onRejected)
    3. function jsforce.promise.prototype.then (onFulfilled, onRejected)
    4. function jsforce.promise.prototype.thenCall (callback)
  15. module jsforce.query
    1. function jsforce.query (conn, config, options)
    2. function jsforce.query.super_ (options)
    3. object jsforce.query.ResponseTargets
  16. module jsforce.query.prototype
    1. function jsforce.query.prototype._execute (options)
    2. function jsforce.query.prototype._expandFields ()
    3. function jsforce.query.prototype._read (size)
    4. function jsforce.query.prototype.addListener (e, fn)
    5. function jsforce.query.prototype.autoFetch (autoFetch)
    6. function jsforce.query.prototype.del (type, callback)
    7. function jsforce.query.prototype.delete (type, callback)
    8. function jsforce.query.prototype.destroy (type, callback)
    9. function jsforce.query.prototype.exec (options, callback)
    10. function jsforce.query.prototype.execute (options, callback)
    11. function jsforce.query.prototype.explain (callback)
    12. function jsforce.query.prototype.filter (fn)
    13. function jsforce.query.prototype.include (childRelName, conditions, fields, options)
    14. function jsforce.query.prototype.limit (limit)
    15. function jsforce.query.prototype.map (fn)
    16. function jsforce.query.prototype.maxFetch (maxFetch)
    17. function jsforce.query.prototype.offset (offset)
    18. function jsforce.query.prototype.on (e, fn)
    19. function jsforce.query.prototype.orderby (sort, dir)
    20. function jsforce.query.prototype.run (options, callback)
    21. function jsforce.query.prototype.scanAll (scanAll)
    22. function jsforce.query.prototype.select (fields)
    23. function jsforce.query.prototype.setResponseTarget (responseTarget)
    24. function jsforce.query.prototype.skip (offset)
    25. function jsforce.query.prototype.sort (sort, dir)
    26. function jsforce.query.prototype.stream (type, options)
    27. function jsforce.query.prototype.then (onResolved, onReject)
    28. function jsforce.query.prototype.thenCall (callback)
    29. function jsforce.query.prototype.toSOQL (callback)
    30. function jsforce.query.prototype.update (mapping, type, callback)
    31. function jsforce.query.prototype.where (conditions)
  17. module jsforce.quick_action
    1. function jsforce.quick_action (conn, path)
  18. module jsforce.quick_action.prototype
    1. function jsforce.quick_action.prototype.defaultValues (contextId, callback)
    2. function jsforce.quick_action.prototype.describe (callback)
    3. function jsforce.quick_action.prototype.execute (contextId, record, callback)
  19. module jsforce.record
    1. function jsforce.record (conn, type, id)
  20. module jsforce.record.prototype
    1. function jsforce.record.prototype.blob (fieldName)
    2. function jsforce.record.prototype.del (options, callback)
    3. function jsforce.record.prototype.delete (options, callback)
    4. function jsforce.record.prototype.destroy (options, callback)
    5. function jsforce.record.prototype.retrieve (options, callback)
    6. function jsforce.record.prototype.update (record, options, callback)
  21. module jsforce.record_stream
    1. function jsforce.record_stream ()
    2. function jsforce.record_stream.Parsable ()
    3. function jsforce.record_stream.Serializable ()
    4. function jsforce.record_stream.filter (fn)
    5. function jsforce.record_stream.map (fn)
    6. function jsforce.record_stream.recordMapStream (record, noeval)
    7. function jsforce.record_stream.super_ (options)
    8. object jsforce.record_stream.DataStreamConverters
  22. module jsforce.record_stream.prototype
    1. function jsforce.record_stream.prototype._transform (record, enc, callback)
    2. function jsforce.record_stream.prototype.filter (fn)
    3. function jsforce.record_stream.prototype.map (fn)
  23. module jsforce.soap
    1. function jsforce.soap (conn, options)
    2. function jsforce.soap.super_ (conn, options)
  24. module jsforce.soap.prototype
    1. function jsforce.soap.prototype._createEnvelope (message)
    2. function jsforce.soap.prototype.beforeSend (request)
    3. function jsforce.soap.prototype.getResponseBody (response)
    4. function jsforce.soap.prototype.invoke (method, args, schema, callback)
    5. function jsforce.soap.prototype.isSessionExpired (response)
    6. function jsforce.soap.prototype.parseError (body)
  25. module jsforce.sobject
    1. function jsforce.sobject (conn, type)
  26. module jsforce.sobject.prototype
    1. function jsforce.sobject.prototype.approvalLayouts (callback)
    2. function jsforce.sobject.prototype.bulkload (operation, options, input, callback)
    3. function jsforce.sobject.prototype.compactLayouts (callback)
    4. function jsforce.sobject.prototype.count (conditions, callback)
    5. function jsforce.sobject.prototype.create (records, options, callback)
    6. function jsforce.sobject.prototype.createBulk (input, callback)
    7. function jsforce.sobject.prototype.del (ids, options, callback)
    8. function jsforce.sobject.prototype.delete (ids, options, callback)
    9. function jsforce.sobject.prototype.deleteBulk (input, callback)
    10. function jsforce.sobject.prototype.deleteHardBulk (input, callback)
    11. function jsforce.sobject.prototype.deleted (start, end, callback)
    12. function jsforce.sobject.prototype.describe (callback)
    13. function jsforce.sobject.prototype.destroy (ids, options, callback)
    14. function jsforce.sobject.prototype.destroyBulk (input, callback)
    15. function jsforce.sobject.prototype.destroyHardBulk (input, callback)
    16. function jsforce.sobject.prototype.find (conditions, fields, options, callback)
    17. function jsforce.sobject.prototype.findOne (conditions, fields, options, callback)
    18. function jsforce.sobject.prototype.insert (records, options, callback)
    19. function jsforce.sobject.prototype.insertBulk (input, callback)
    20. function jsforce.sobject.prototype.layouts (layoutName, callback)
    21. function jsforce.sobject.prototype.listview (id)
    22. function jsforce.sobject.prototype.listviews (callback)
    23. function jsforce.sobject.prototype.quickAction (actionName)
    24. function jsforce.sobject.prototype.quickActions (callback)
    25. function jsforce.sobject.prototype.recent (callback)
    26. function jsforce.sobject.prototype.record (id)
    27. function jsforce.sobject.prototype.retrieve (ids, options, callback)
    28. function jsforce.sobject.prototype.select (fields, callback)
    29. function jsforce.sobject.prototype.update (records, options, callback)
    30. function jsforce.sobject.prototype.updateBulk (input, callback)
    31. function jsforce.sobject.prototype.updated (start, end, callback)
    32. function jsforce.sobject.prototype.upsert (records, extIdField, options, callback)
    33. function jsforce.sobject.prototype.upsertBulk (input, extIdField, callback)
  27. module jsforce.soql_builder
    1. function jsforce.soql_builder.createSOQL (query)

module jsforce

function jsforce.cache ()

function jsforce.date (literal)

function jsforce.http_api (conn, options)

function jsforce.logger (logLevel)

function jsforce.promise (fn)

function jsforce.query (conn, config, options)

function jsforce.quick_action (conn, path)

function jsforce.record (conn, type, id)

function jsforce.record_stream ()

function jsforce.soap (conn, options)

function jsforce.sobject (conn, type)

module jsforce.cache

function jsforce.cache ()

module jsforce.cache.prototype

function jsforce.cache.prototype.clear (key)

function jsforce.cache.prototype.get (key)

function jsforce.cache.prototype.makeCacheable (fn, scope, options)

function jsforce.cache.prototype.makeResponseCacheable (fn, scope, options)

module jsforce.canvas

function jsforce.canvas.createRequest (signedRequest)

module jsforce.csv

function jsforce.csv.parseCSV (str, options)

function jsforce.csv.parseCSVStream (options)

function jsforce.csv.serializeCSVStream (options)

function jsforce.csv.toCSV (records, options)

module jsforce.date

function jsforce.date (literal)

function jsforce.date.LAST_N_DAYS (num)

function jsforce.date.LAST_N_FISCAL_QUARTERS (num)

function jsforce.date.LAST_N_FISCAL_YEARS (num)

function jsforce.date.LAST_N_MONTHS (num)

function jsforce.date.LAST_N_QUARTERS (num)

function jsforce.date.LAST_N_WEEKS (num)

function jsforce.date.LAST_N_YEARS (num)

function jsforce.date.NEXT_N_DAYS (num)

function jsforce.date.NEXT_N_FISCAL_QUARTERS (num)

function jsforce.date.NEXT_N_FISCAL_YEARS (num)

function jsforce.date.NEXT_N_MONTHS (num)

function jsforce.date.NEXT_N_QUARTERS (num)

function jsforce.date.NEXT_N_WEEKS (num)

function jsforce.date.NEXT_N_YEARS (num)

function jsforce.date.parseDate (str)

function jsforce.date.toDateLiteral (date)

function jsforce.date.toDateTimeLiteral (date)

module jsforce.date.prototype

function jsforce.date.prototype.toJSON ()

function jsforce.date.prototype.toString ()

module jsforce.http_api

function jsforce.http_api (conn, options)

function jsforce.http_api.SessionRefreshDelegate (conn, refreshFn)

function jsforce.http_api.super_ ()

module jsforce.http_api.prototype

function jsforce.http_api.prototype.beforeSend (request)

function jsforce.http_api.prototype.getError (response, body)

function jsforce.http_api.prototype.getRefreshDelegate ()

function jsforce.http_api.prototype.getResponseBody (response)

function jsforce.http_api.prototype.getResponseContentType (response)

function jsforce.http_api.prototype.hasErrorInResponseBody (body)

function jsforce.http_api.prototype.isErrorResponse (response)

function jsforce.http_api.prototype.isSessionExpired (response)

function jsforce.http_api.prototype.parseError (body)

function jsforce.http_api.prototype.parseResponseBody (response)

function jsforce.http_api.prototype.request (request, callback)

module jsforce.jsonp

function jsforce.jsonp.createRequest (jsonpParam, timeout)

module jsforce.logger

function jsforce.logger (logLevel)

module jsforce.logger.prototype

function jsforce.logger.prototype.debug (message)

function jsforce.logger.prototype.error (message)

function jsforce.logger.prototype.fatal (message)

function jsforce.logger.prototype.info (message)

function jsforce.logger.prototype.log (level, message)

function jsforce.logger.prototype.warn (message)

module jsforce.promise

function jsforce.promise (fn)

function jsforce.promise._61 ()

function jsforce.promise.all (arr)

function jsforce.promise.defer ()

function jsforce.promise.race (values)

function jsforce.promise.reject (value)

function jsforce.promise.resolve (value)

module jsforce.promise.prototype

function jsforce.promise.prototype.catch (onRejected)

function jsforce.promise.prototype.fail (onRejected)

function jsforce.promise.prototype.then (onFulfilled, onRejected)

function jsforce.promise.prototype.thenCall (callback)

module jsforce.query

function jsforce.query (conn, config, options)

function jsforce.query.super_ (options)

module jsforce.query.prototype

function jsforce.query.prototype._execute (options)

function jsforce.query.prototype._expandFields ()

function jsforce.query.prototype._read (size)

function jsforce.query.prototype.addListener (e, fn)

function jsforce.query.prototype.autoFetch (autoFetch)

function jsforce.query.prototype.del (type, callback)

function jsforce.query.prototype.delete (type, callback)

function jsforce.query.prototype.destroy (type, callback)

function jsforce.query.prototype.exec (options, callback)

function jsforce.query.prototype.execute (options, callback)

function jsforce.query.prototype.explain (callback)

function jsforce.query.prototype.filter (fn)

function jsforce.query.prototype.include (childRelName, conditions, fields, options)

function jsforce.query.prototype.limit (limit)

function jsforce.query.prototype.map (fn)

function jsforce.query.prototype.maxFetch (maxFetch)

function jsforce.query.prototype.offset (offset)

function jsforce.query.prototype.on (e, fn)

function jsforce.query.prototype.orderby (sort, dir)

function jsforce.query.prototype.run (options, callback)

function jsforce.query.prototype.scanAll (scanAll)

function jsforce.query.prototype.select (fields)

function jsforce.query.prototype.setResponseTarget (responseTarget)

function jsforce.query.prototype.skip (offset)

function jsforce.query.prototype.sort (sort, dir)

function jsforce.query.prototype.stream (type, options)

function jsforce.query.prototype.then (onResolved, onReject)

function jsforce.query.prototype.thenCall (callback)

function jsforce.query.prototype.toSOQL (callback)

function jsforce.query.prototype.update (mapping, type, callback)

function jsforce.query.prototype.where (conditions)

module jsforce.quick_action

function jsforce.quick_action (conn, path)

module jsforce.quick_action.prototype

function jsforce.quick_action.prototype.defaultValues (contextId, callback)

function jsforce.quick_action.prototype.describe (callback)

function jsforce.quick_action.prototype.execute (contextId, record, callback)

module jsforce.record

function jsforce.record (conn, type, id)

module jsforce.record.prototype

function jsforce.record.prototype.blob (fieldName)

function jsforce.record.prototype.del (options, callback)

function jsforce.record.prototype.delete (options, callback)

function jsforce.record.prototype.destroy (options, callback)

function jsforce.record.prototype.retrieve (options, callback)

function jsforce.record.prototype.update (record, options, callback)

module jsforce.record_stream

function jsforce.record_stream ()

function jsforce.record_stream.Parsable ()

function jsforce.record_stream.Serializable ()

function jsforce.record_stream.filter (fn)

function jsforce.record_stream.map (fn)

function jsforce.record_stream.recordMapStream (record, noeval)

function jsforce.record_stream.super_ (options)

module jsforce.record_stream.prototype

function jsforce.record_stream.prototype._transform (record, enc, callback)

function jsforce.record_stream.prototype.filter (fn)

function jsforce.record_stream.prototype.map (fn)

module jsforce.soap

function jsforce.soap (conn, options)

function jsforce.soap.super_ (conn, options)

module jsforce.soap.prototype

function jsforce.soap.prototype._createEnvelope (message)

function jsforce.soap.prototype.beforeSend (request)

function jsforce.soap.prototype.getResponseBody (response)

function jsforce.soap.prototype.invoke (method, args, schema, callback)

function jsforce.soap.prototype.isSessionExpired (response)

function jsforce.soap.prototype.parseError (body)

module jsforce.sobject

function jsforce.sobject (conn, type)

module jsforce.sobject.prototype

function jsforce.sobject.prototype.approvalLayouts (callback)

function jsforce.sobject.prototype.bulkload (operation, options, input, callback)

function jsforce.sobject.prototype.compactLayouts (callback)

function jsforce.sobject.prototype.count (conditions, callback)

function jsforce.sobject.prototype.create (records, options, callback)

function jsforce.sobject.prototype.createBulk (input, callback)

function jsforce.sobject.prototype.del (ids, options, callback)

function jsforce.sobject.prototype.delete (ids, options, callback)

function jsforce.sobject.prototype.deleteBulk (input, callback)

function jsforce.sobject.prototype.deleteHardBulk (input, callback)

function jsforce.sobject.prototype.deleted (start, end, callback)

function jsforce.sobject.prototype.describe (callback)

function jsforce.sobject.prototype.destroy (ids, options, callback)

function jsforce.sobject.prototype.destroyBulk (input, callback)

function jsforce.sobject.prototype.destroyHardBulk (input, callback)

function jsforce.sobject.prototype.find (conditions, fields, options, callback)

function jsforce.sobject.prototype.findOne (conditions, fields, options, callback)

function jsforce.sobject.prototype.insert (records, options, callback)

function jsforce.sobject.prototype.insertBulk (input, callback)

function jsforce.sobject.prototype.layouts (layoutName, callback)

function jsforce.sobject.prototype.listview (id)

function jsforce.sobject.prototype.listviews (callback)

function jsforce.sobject.prototype.quickAction (actionName)

function jsforce.sobject.prototype.quickActions (callback)

function jsforce.sobject.prototype.recent (callback)

function jsforce.sobject.prototype.record (id)

function jsforce.sobject.prototype.retrieve (ids, options, callback)

function jsforce.sobject.prototype.select (fields, callback)

function jsforce.sobject.prototype.update (records, options, callback)

function jsforce.sobject.prototype.updateBulk (input, callback)

function jsforce.sobject.prototype.updated (start, end, callback)

function jsforce.sobject.prototype.upsert (records, extIdField, options, callback)

function jsforce.sobject.prototype.upsertBulk (input, extIdField, callback)

module jsforce.soql_builder

function jsforce.soql_builder.createSOQL (query)

[ this document was created with utility2 ]