Class: QuickAction

QuickAction

(protected) new QuickAction()

A class for quick action
Source:

Methods

defaultValues(contextIdopt, callbackopt) → {Promise.<Record>}

Retrieve default field values in the action (for given record, if specified)
Parameters:
Name Type Attributes Description
contextId String <optional>
 ID of record to get default values specific to the record
callback Callback.<Record> <optional>
 Callback function
Source:
Returns:
Type
Promise.<Record>

describe(callbackopt) → {Promise.<QuickAction~QuickActionDescriveInfo>}

Describe the action's information (including layout, etc.)
Parameters:
Name Type Attributes Description
callback Callback.<QuickAction~QuickActionDescriveInfo> <optional>
 Callback function
Source:
Returns:
Type
Promise.<QuickAction~QuickActionDescriveInfo>

execute(contextId, record, callbackopt) → {Promise.<QuickAction~QuickActionResult>}

Execute the action for given context Id and record information
Parameters:
Name Type Attributes Description
contextId String Context record ID of the action
record Record Input record information for the action
callback Callback.<QuickAction~QuickActionResult> <optional>
 Callback function
Source:
Returns:
Type
Promise.<QuickAction~QuickActionResult>

Type Definitions

QuickActionDescriveInfo

Type:
Properties:
Name Type Description
contextSobjectType String Object type used for the action
targetSobjectType String Object type of the action to target
targetParentField String Field name in the target object which refers parent(context) object record ID.
targetRecordTypeId String Record type of the targeted record
layout Object Layout sections that comprise an action
Source:

QuickActionInfo

Type:
  • Object
Properties:
Name Type Description
type String Type of the action (e.g. Create, Update, Post, LogACall)
name String Name of the action
label String Label of the action
urls Object Endpoint URL information of the action
Source:

QuickActionResult

Type:
  • Object
Source: