Record.getMacros()

Note:

The content in this help topic pertains to SuiteScript 2.0.

Method Description

Provides a plain JavaScript object of available macro objects defined for a record type, indexed by the Macro ID. The object returns one or more record.Macro objects. If there are no macros available for the specified record type, an empty object is returned.

For information about record macros, see Overview of Record Action and Macro APIs.

Returns

Object

Supported Script Types

Client and server scripts

For additional information, see SuiteScript 2.x Script Types.

Governance

None

Module

N/record Module

Sibling Object Members

Record Object Members

Since

2018.2

Errors

Error Code

Thrown If

SSS_INVALID_RECORD_TYPE

The specified record type is invalid.

Syntax

Important:

The following code sample shows the syntax for this member. It is not a functional example. For a complete script example, see N/record Module Script Samples.

          // Add additional code
...
var macroList = recordObj.getMacros();
...
// Add additional code 

        

Related Topics

N/record Module
SuiteScript 2.x Modules
SuiteScript 2.x

General Notices