Source: quick-action.js

  1. /**
  2.  * @file Represents Salesforce QuickAction
  3.  * @author Shinichi Tomita <shinichi.tomita@gmail.com>
  4.  */
  6. 'use strict';
  9. /**
  10.  * A class for quick action
  11.  *
  12.  * @protected
  13.  * @constructor
  14.  */
  15. var QuickAction = module.exports = function(conn, path) {
  16.   this._conn = conn;
  17.   this._path = path;
  18. };
  20. /**
  21.  * @typedef {Object} QuickAction~QuickActionInfo
  22.  * @prop {String} type - Type of the action (e.g. Create, Update, Post, LogACall)
  23.  * @prop {String} name - Name of the action
  24.  * @prop {String} label - Label of the action
  25.  * @prop {Object} urls - Endpoint URL information of the action
  26.  */
  27. /**
  28.  * @typedef {QuickAction~QuickActionInfo} QuickAction~QuickActionDescriveInfo
  29.  * @prop {String} contextSobjectType - Object type used for the action
  30.  * @prop {String} targetSobjectType - Object type of the action to target
  31.  * @prop {String} targetParentField - Field name in the target object which refers parent(context) object record ID.
  32.  * @prop {String} targetRecordTypeId - Record type of the targeted record
  33.  * @prop {Object} layout - Layout sections that comprise an action
  34.  */
  36. /**
  37.  * Describe the action's information (including layout, etc.)
  38.  *
  39.  * @param {Callback.<QuickAction~QuickActionDescriveInfo>} [callback] - Callback function
  40.  * @returns {Promise.<QuickAction~QuickActionDescriveInfo>}
  41.  */
  42. QuickAction.prototype.describe = function(callback) {
  43.   var url = this._path + "/describe";
  44.   return this._conn.request(url).thenCall(callback);
  45. };
  47. /**
  48.  * Retrieve default field values in the action (for given record, if specified)
  49.  *
  50.  * @param {String} [contextId] - ID of record to get default values specific to the record
  51.  * @param {Callback.<Record>} [callback] - Callback function
  52.  * @returns {Promise.<Record>}
  53.  */
  54. QuickAction.prototype.defaultValues = function(contextId, callback) {
  55.   if (typeof contextId === 'function') {
  56.     callback = contextId;
  57.     contextId = null;
  58.   }
  59.   var url = this._path + "/defaultValues";
  60.   if (contextId) {
  61.     url += "/" + contextId;
  62.   }
  63.   return this._conn.request(url).thenCall(callback);
  64. };
  66. /**
  67.  * @typedef {Object} QuickAction~QuickActionResult
  68.  * @param {String} id - Record id of the action result
  69.  * @param {Array.<String>} feedItemIds - List of IDs for feed item
  70.  * @param {Boolean} success - True if the action successfully completed
  71.  * @param {Boolean} created - True if the action yields a new record
  72.  * @param {String} contextId - Context record ID of the action
  73.  * @param {Array.<Object>} errors - Errors if the action failed
  74.  */
  76. /**
  77.  * Execute the action for given context Id and record information
  78.  * 
  79.  * @param {String} contextId - Context record ID of the action
  80.  * @param {Record} record - Input record information for the action
  81.  * @param {Callback.<QuickAction~QuickActionResult>} [callback] - Callback function
  82.  * @returns {Promise.<QuickAction~QuickActionResult>}
  83.  */
  84. QuickAction.prototype.execute = function(contextId, record, callback) {
  85.   var body = {
  86.     contextId: contextId,
  87.     record: record
  88.   };
  89.   return this._conn.requestPost(this._path, body).thenCall(callback);
  90. };