N/recordContext Module Members

The N/recordContext module provides developers with critical functionality to work with record contexts in SuiteScript. This module includes various members that offer insights and methods pertaining to the context within which records are processed.

What are the Members of the N/recordContext Module?

The N/recordContext module consists of the following key members:

Understanding the getContext Method

The recordContext.getContext(options) method is pivotal for accessing the context of records, particularly depending on whether the record is currently loaded in your script.

• For Unloaded Records: When a record is not yet loaded, the record is specified through the recordType and recordId parameters:

  javascriptCopy

  recordContext.getContext({
      recordType: 'customer',
      recordId: '123'
  });

• For Loaded Records: If the record is already loaded in your script, use the record parameter:

  javascriptCopy

  recordContext.getContext({
      record: customerRecord
  });

Parameters of the getContext Method

The options parameter is a JavaScript object that consists of several keys:

• recordType: string, required if the record is not loaded in your script.
• recordId: string, required if the record is not loaded in your script.
• record: record.Record, required if the record is loaded in your script.
• contextTypes: Array<string>, optional, specifies the types of contexts to retrieve.

Common Errors

The method may throw various errors based on the parameters provided:

• MUTUALY_EXCLUSIVE_ARGUMENT: Thrown if both a loaded record and a record ID/record type are provided.
• MISSING_REQD_ARGUMENT: Triggered when a required parameter is missing.
• SSS_INVALID_TYPE_ARG: Indicates a wrong parameter type was provided.
• UNKNOWN_CONTEXT_TYPE: Occurs if an invalid context type is given.

By understanding these module members and their appropriate usage, developers can effectively manage record context in their SuiteScript applications.

Key Takeaways

• The N/recordContext module is essential for accessing record contexts in SuiteScript.
• The getContext method can retrieve contexts for both loaded and unloaded records.
• Proper use of parameters is critical to preventing errors during context retrieval.