Source: record.js

  1. /**
  2.  * @file Represents Salesforce record information
  3.  * @author Shinichi Tomita <shinichi.tomita@gmail.com>
  4.  */
  6. 'use strict';
  8. var _ = require('lodash/core');
  10. /**
  11.  * A simple hash object including record field information
  12.  *
  13.  * @typedef {Object} Record
  14.  */
  16. /**
  17.  * Remote reference to record information
  18.  *
  19.  * @protected
  20.  * @class
  21.  * @constructor
  22.  * @param {Connection} conn - Connection object
  23.  * @param {String} type - SObject type
  24.  * @param {String} id - Record ID
  25.  */
  26. var RecordReference = module.exports = function(conn, type, id) {
  27.   this._conn = conn;
  28.   this.type = type;
  29.   this.id = id;
  30. };
  32. /**
  33.  * Retrieve record field information
  34.  *
  35.  * @param {Object} [options] - Options for rest api.
  36.  * @param {Callback.<Record>} [callback] - Callback function
  37.  * @returns {Promise.<Record>}
  38.  */
  39. RecordReference.prototype.retrieve = function(options, callback) {
  40.   if (typeof options === 'function') {
  41.     callback = options;
  42.     options = {};
  43.   }
  44.   return this._conn.retrieve(this.type, this.id, options, callback);
  45. };
  47. /**
  48.  * Update record field information
  49.  *
  50.  * @param {Record} record - A Record which includes fields to update
  51.  * @param {Object} [options] - Options for rest api.
  52.  * @param {Callback.<RecordResult>} [callback] - Callback function
  53.  * @returns {Promise.<RecordResult>}
  54.  */
  55. RecordReference.prototype.update = function(record, options, callback) {
  56.   if (typeof options === 'function') {
  57.     callback = options;
  58.     options = {};
  59.   }
  60.   record = _.clone(record);
  61.   record.Id = this.id;
  62.   return this._conn.update(this.type, record, options, callback);
  63. };
  65. /**
  66.  * Synonym of Record#destroy()
  67.  *
  68.  * @method RecordReference#delete
  69.  * @param {Object} [options] - Options for rest api.
  70.  * @param {Callback.<RecordResult>} [callback] - Callback function
  71.  * @returns {Promise.<RecordResult>}
  72.  */
  73. RecordReference.prototype["delete"] =
  74. /**
  75.  * Synonym of Record#destroy()
  76.  *
  77.  * @method RecordReference#del
  78.  * @param {Callback.<RecordResult>} [callback] - Callback function
  79.  * @returns {Promise.<RecordResult>}
  80.  */
  81. RecordReference.prototype.del =
  82. /**
  83.  * Delete record field
  84.  *
  85.  * @method RecordReference#destroy
  86.  * @param {Object} [options] - Options for rest api.
  87.  * @param {Callback.<RecordResult>} [callback] - Callback function
  88.  * @returns {Promise.<RecordResult>}
  89.  */
  90. RecordReference.prototype.destroy = function(options, callback) {
  91.   if (typeof options === 'function') {
  92.     callback = options;
  93.     options = {};
  94.   }
  95.   return this._conn.destroy(this.type, this.id, options, callback);
  96. };
  98. /**
  99.  * Get blob field as stream
  100.  *
  101.  * @param {String} fieldName - Blob field name
  102.  * @returns {stream.Stream}
  103.  */
  104. RecordReference.prototype.blob = function(fieldName) {
  105.   var url = [ this._conn._baseUrl(), 'sobjects', this.type, this.id, fieldName ].join('/');
  106.   return this._conn.request(url).stream();
  107. };