SuiteScript 1.0 to SuiteScript 2.x API Map - Objects (nlobj)

nlobjAssistant

serverWidget.Assistant

N/ui/serverWidget Module

-

nlobjAssistant.addField(name, type, label, source, group)

Assistant.addField(options)

N/ui/serverWidget Module

-

nlobjAssistant.addFieldGroup(name, label)

Assistant.addFieldGroup(options)

N/ui/serverWidget Module

-

nlobjAssistant.addStep(name, label)

Assistant.addStep(options)

N/ui/serverWidget Module

-

nlobjAssistant.addSubList(name, type, label)

Assistant.addSublist(options)

N/ui/serverWidget Module

-

nlobjAssistant.getAllFields()

Assistant.getFieldIds()

N/ui/serverWidget Module

-

nlobjAssistant.getAllFieldGroups()

Assistant.getFieldGroupIds()

N/ui/serverWidget Module

-

nlobjAssistant.getAllSteps()

Assistant.getSteps()

N/ui/serverWidget Module

-

nlobjAssistant.getAllSubLists()

Assistant.getSublistIds()

N/ui/serverWidget Module

-

nlobjAssistant.getCurrentStep()

Assistant.currentStep

N/ui/serverWidget Module

Note that currentStep is a property.

nlobjAssistant.getField(name)

Assistant.getField(options)

N/ui/serverWidget Module

-

nlobjAssistant.getFieldGroup(name)

Assistant.getFieldGroup(options)

N/ui/serverWidget Module

-

nlobjAssistant.getLastAction()

Assistant.getLastAction()

N/ui/serverWidget Module

-

nlobjAssistant.getLastStep()

Assistant.getLastStep()

N/ui/serverWidget Module

-

nlobjAssistant.getNextStep()

Assistant.getNextStep()

N/ui/serverWidget Module

-

nlobjAssistant.getStep(name)

Assistant.getStep(options)

N/ui/serverWidget Module

-

nlobjAssistant.getSubList(name)

Assistant.getSublist(options)

N/ui/serverWidget Module

-

nlobjAssistant.hasError()

Assistant.hasErrorHtml()

N/ui/serverWidget Module

-

nlobjAssistant.isFinished()

Assistant.isFinished()

N/ui/serverWidget Module

-

nlobjAssistant.sendRedirect(response)

Assistant.sendRedirect(options)

N/ui/serverWidget Module

-

nlobjAssistant.setCurrentStep(step)

Assistant.currentStep

N/ui/serverWidget Module

Note that currentStep is a property.

nlobjAssistant.setError(html)

Assistant.errorHtml

N/ui/serverWidget Module

Note that errorHtml is a property.

nlobjAssistant.setFieldValues(values)

Assistant.updateDefaultValues(values)

N/ui/serverWidget Module

-

nlobjAssistant.setFinished(html)

Assistant.finishedHtml

N/ui/serverWidget Module

Note that finishedHtml is a property.

nlobjAssistant.setNumbered(hasStepNumber)

Assistant.hideStepNumber

N/ui/serverWidget Module

Note that hideStepNumber is a property.

nlobjAssistant.setOrdered(ordered)

Assistant.isNotOrdered

N/ui/serverWidget Module

Note that isNotOrdered is a property.

nlobjAssistant.setScript(script)

Assistant.clientScriptFileId

Assistant.clientScriptModulePath

N/ui/serverWidget Module

Note that clientScriptFileId and clientScriptModulePath are properties.

Use one of these SuiteScript 2.x properties to attach an ad hoc client script to an assistant.

nlobjAssistant.setShortcut(show)

Assistant.hideAddToShortcutsLink

N/ui/serverWidget Module

Note that hideAddToShortcutsLink is a property.

nlobjAssistant.setSplash(title, text1,text2)

Assistant.setSplash(options)

N/ui/serverWidget Module

-

nlobjAssistant.setTitle(title)

Assistant.title

N/ui/serverWidget Module

Note that title is a property.

nlobjAssistantStep

serverWidget.AssistantStep

N/ui/serverWidget Module

-

nlobjAssistantStep.getAllFields()

AssistantStep.getFieldIds()

N/ui/serverWidget Module

-

nlobjAssistantStep.getAllLineItemFields(group)

AssistantStep.getSublistFieldIds(options)

N/ui/serverWidget Module

-

nlobjAssistantStep.getAllLineItems()

AssistantStep.getSubmittedSublistIds()

N/ui/serverWidget Module

-

nlobjAssistantStep.getFieldValue(name)

AssistantStep.getValue(options)

N/ui/serverWidget Module

-

nlobjAssistantStep.getFieldValues(name)

AssistantStep.getValue(options)

N/ui/serverWidget Module

-

nlobjAssistantStep.getLineItemCount(group)

AssistantStep.getLineCount(options)

N/ui/serverWidget Module

-

nlobjAssistantStep.getLineItemValue(group, name, line)

AssistantStep.getSublistValue(options)

N/ui/serverWidget Module

-

nlobjAssistantStep.getStepNumber()

AssistantStep.stepNumber

N/ui/serverWidget Module

Note that stepNumber is a property.

nlobjAssistantStep.setHelpText(help)

AssistantStep.helpText

N/ui/serverWidget Module

Note that helpText is a property.

nlobjAssistantStep.setLabel(label)

AssistantStep.label

N/ui/serverWidget Module

Note that label is a property.

nlobjButton

serverWidget.Button

N/ui/serverWidget Module

-

nlobjButton.setDisabled(disabled)

Button.isDisabled

N/ui/serverWidget Module

Note that isDisabled is a property.

nlobjButton.setLabel(label)

Button.label

N/ui/serverWidget Module

Note that label is a property.

nlobjButton.setVisible(visible)

Button.isHidden

N/ui/serverWidget Module

Note that isHidden is a property.

nlobjColumn

serverWidget.ListColumn

N/ui/serverWidget Module

-

nlobjColumn.addParamToURL(param, value, dynamic)

ListColumn.addParamToURL(options)

N/ui/serverWidget Module

-

nlobjColumn.setLabel(label)

ListColumn.label

N/ui/serverWidget Module

Note that label is a property.

nlobjColumn.setURL(url, dynamic)

ListColumn.setURL(options)

N/ui/serverWidget Module

-

nlobjConfiguration

record.Record

N/record Module

Use the N/config Module method, config.load(options), to return a record.Record object. Then use the record.Record object members to access the specified configuration page.

For a script sample, see N/config Module Script Sample.

nlobjConfiguration.getAllFields()

Record.getFields()

N/record Module

-

nlobjConfiguration.getField(fldnam)

Record.getField(options)

N/record Module

-

nlobjConfiguration.getFieldText(name)

Record.getText(options)

N/record Module

-

nlobjConfiguration.getFieldTexts(name)

Record.getText(options)

N/record Module

-

nlobjConfiguration.getFieldValue(name)

Record.getValue(options)

N/record Module

-

nlobjConfiguration.getFieldValues(name)

Record.getValue(options)

N/record Module

-

nlobjConfiguration.getType()

Record.type

N/record Module

Note that type is a property.

nlobjConfiguration.setFieldText(name, text)

Record.setText(options)

N/record Module

-

nlobjConfiguration.setFieldTexts(name, text)

Record.setText(options)

N/record Module

-

nlobjConfiguration.setFieldValue(name, value)

Record.setValue(options)

N/record Module

-

nlobjConfiguration.setFieldValues(name, value)

Record.setValue(options)

N/record Module

-

nlobjContext

runtime.Script

runtime.Session

runtime.User

N/runtime Module

-

nlobjContext.getCompany()

runtime.accountId

N/runtime Module

Note that accountId is a property.

nlobjContext.getDepartment()

User.department

N/runtime Module

Note that department is a property.

nlobjContext.getDeploymentId()

Script.deploymentId

N/runtime Module

Note that deploymentId is a property.

nlobjContext.getEmail()

User.email

N/runtime Module

Note that email is a property.

nlobjContext.getEnvironment()

runtime.envType

N/runtime Module

Note that envType is a property.

nlobjContext.getExecutionContext()

runtime.executionContext

N/runtime Module

Note that executionContext is a property.

nlobjContext.getFeature(name)

runtime.isFeatureInEffect(options)

N/runtime Module

-

nlobjContext.getLocation()

User.location

N/runtime Module

Note that location is a property.

nlobjContext.getLogLevel()

Script.logLevel

N/runtime Module

Note that logLevel is a property.

nlobjContext.getName()

User.name

N/runtime Module

Note that name is a property.

nlobjContext.getPercentComplete()

Script.percentComplete

N/runtime Module

Note that percentComplete is a property.

For a script sample, see N/runtime Module Script Samples.

nlobjContext.getPermission(name)

User.getPermission(options)

N/runtime Module

-

nlobjContext.getPreference(name)

User.getPreference(options)

N/runtime Module

-

nlobjContext.getQueueCount()

runtime.queueCount

N/runtime Module

Note that queueCount is a property.

nlobjContext.getRemainingUsage()

Script.getRemainingUsage()

N/runtime Module

-

nlobjContext.getRole()

User.role

N/runtime Module

Note that role is a property.

nlobjContext.getRoleCenter()

User.roleCenter

N/runtime Module

Note that roleCenter is a property.

nlobjContext.getRoleId()

User.roleId

N/runtime Module

Note that roleId is a property.

nlobjContext.getScriptId()

Script.id

N/runtime Module

Note that id is a property.

nlobjContext.getSessionObject(name)

Session.get(options)

N/runtime Module

-

nlobjContext.getSetting(type, name)

Script.getParameter(options)

Session.get(options)

runtime.isFeatureInEffect(options)

User.getPermission(options)

N/runtime Module

The method Script.getParameter(options) is equivalent to nlobjContext.getSetting('SCRIPT', name).

The method Session.get(options) is equivalent to nlobjContext.getSetting('SESSION', name).

The method runtime.isFeatureInEffect(options) is equivalent to nlobjContext.getSetting('FEATURE', name).

The method User.getPermission(options) is equivalent to nlobjContext.getSetting('PERMISSION', name).

nlobjContext.getSubsidiary()

User.subsidiary

N/runtime Module

Note that subsidiary is a property.

nlobjContext.getUser()

User.id

N/runtime Module

Note that id is a property.

nlobjContext.getVersion()

runtime.version

N/runtime Module

Note that version is a property.

nlobjContext.setPercentComplete(pct)

Script.percentComplete

N/runtime Module

Note that percentComplete is a property.

nlobjContext.setSessionObject(name, value)

Session.set(options)

N/runtime Module

-

nlobjContext.setSetting(type, name, value)

Session.set(options)

N/runtime Module

-

nlobjCredentialBuilder(string, domainString)

https.SecureString

N/https Module

-

nlobjCredentialBuilder.append(string)

SecureString.appendSecureString(options)

SecureString.appendString(options)

N/https Module

-

nlobjCredentialBuilder.base64()

SecureString.convertEncoding(options)

N/https Module

-

nlobjCredentialBuilder.replace(string1, string2)

SecureString.replaceString(options)

N/https Module

-

nlobjCredentialBuilder.sha256()

SecureString.hash(options)

N/https Module

-

nlobjCredentialBuilder.utf8()

SecureString.convertEncoding(options)

N/https Module

-

nlobjCSVImport

task.CsvImportTask

N/task Module

Returned by task.create(options).

                    var csvImpTaskObj = task.create({
    taskType: task.TaskType.CSV_IMPORT,
    //Other Params
}); 

                  

nlobjCSVImport.setLinkedFile(sublist, file)

CsvImportTask.linkedFiles

N/task Module

Note that linkedFiles is a property.

nlobjCSVImport.setMapping(savedImport)

CsvImportTask.mappingId

N/task Module

Note that mappingId is a property.

nlobjCSVImport.setOption(option, value)

CsvImportTask.name

N/task Module

Note that name is a property.

nlobjCSVImport.setPrimaryFile(file)

CsvImportTask.importFile

N/task Module

Note that importFile is a property.

nlobjCSVImport.setQueue(string)

CsvImportTask.queueId

N/task Module

Note that queueId is a property.

nlobjDuplicateJobRequest

task.EntityDeduplicationTask

N/task Module

Returned by task.create(options).

                    var dedupTaskObj = task.create({
    taskType: task.TaskType.ENTITY_DEDUPLICATION,
    //Other Params
}); 

                  

nlobjDuplicateJobRequest.setEntityType(entityType)

EntityDeduplicationTask.entityType

N/task Module

Note that entityType is a property.

nlobjDuplicateJobRequest.setMasterId(masterID)

EntityDeduplicationTask.masterRecordId

N/task Module

-

nlobjDuplicateJobRequest.setMasterSelectionMode(mode)

EntityDeduplicationTask.masterSelectionMode

N/task Module

Note that masterSelectionMode is a property.

nlobjDuplicateJobRequest.setOperation(operation)

EntityDeduplicationTask.dedupeMode

N/task Module

Note that dedupeMode is a property.

nlobjDuplicateJobRequest.setRecords(dupeRecords)

EntityDeduplicationTask.recordIds

N/task Module

Note that recordIds is a property.

nlobjEmailMerger

render.EmailMergeResult

N/render Module

-

nlobjEmailMerger.merge()

See Notes

N/render Module

In SuiteScript 2.x, this is automatically called in render.mergeEmail(options).

nlobjEmailMerger.setCustomRecord(recordType, recordId)

See Notes

N/render Module

In SuiteScript 2.x, this value is set with a render.mergeEmail(options) parameter.

nlobjEmailMerger.setEntity(entityType, entityId)

See Notes

N/render Module

In SuiteScript 2.x, this value is set with a render.mergeEmail(options) parameter.

nlobjEmailMerger.setRecipient(recipientType, recipientId)

See Notes

N/render Module

In SuiteScript 2.x, this value is set with a render.mergeEmail(options) parameter.

nlobjEmailMerger.setSupportCase(caseId)

See Notes

N/render Module

In SuiteScript 2.x, this value is set with a render.mergeEmail(options) parameter.

nlobjEmailMerger.setTransaction(transactionId)

See Notes

N/render Module

In SuiteScript 2.x, this value is set with a render.mergeEmail(options) parameter.

nlobjError

error.SuiteScriptError

N/error Module

-

nlobjError.getCode()

SuiteScriptError.name

N/error Module

Note that SuiteScriptError.name is a property.

nlobjError.getDetails()

SuiteScriptError.message

N/error Module

Note that SuiteScriptError.message is a property.

nlobjError.getId()

SuiteScriptError.id

N/error Module

Note that SuiteScriptError.id is a property.

nlobjError.getInternalId()

SuiteScriptError.id

N/error Module

Note that SuiteScriptError.id is a property.

nlobjError.getStackTrace()

SuiteScriptError.stack

N/error Module

Note that SuiteScriptError.stack is a property

nlobjError.getUserEvent()

-

-

-

nlobjField

serverWidget.Field

record.Field

N/ui/serverWidget Module

N/record Module

Use the N/ui/serverWidget module to create and modify form fields in a Suitelet.

Use the N/record module to access field metadata in client and server scripts.

nlobjFieldGroup

serverWidget.FieldGroup

N/ui/serverWidget Module

-

nlobjFieldGroup.setCollapsible(collapsible, hidden)

FieldGroup.isCollapsible

N/ui/serverWidget Module

Note that isCollapsible is a property.

nlobjFieldGroup.setLabel(label)

FieldGroup.label

N/ui/serverWidget Module

Note that label is a property.

nlobjFieldGroup.setShowBorder(show)

FieldGroup.isBorderHidden

N/ui/serverWidget Module

Note that isBorderHidden is a property.

nlobjFieldGroup.setSingleColumn(column)

FieldGroup.isSingleColumn

N/ui/serverWidget Module

Note that isSingleColumn is a property.

nlobjFile

file.File

N/file Module

For a script sample, see N/file Module Script Samples.

nlobjFile.getDescription()

File.description

N/file Module

Note that description is a property.

nlobjFile.getFolder()

File.folder

N/file Module

Note that folder is a property.

For a script sample, see N/file Module Script Samples.

nlobjFile.getId()

File.id

N/file Module

Note that id is a property.

For a script sample, see N/file Module Script Samples.

nlobjFile.getName()

File.name

N/file Module

Note that name is a property.

For a script sample, see N/file Module Script Samples.

nlobjFile.getSize()

File.size

N/file Module

Note that size is a property.

nlobjFile.getType()

File.fileType

N/file Module

Note that fileType is a property.

For a script sample, see N/file Module Script Samples.

nlobjFile.getURL()

File.url

N/file Module

Note that url is a property.

nlobjFile.getValue()

File.getContents()

N/file Module

-

nlobjFile.isInactive()

File.isInactive

N/file Module

Note that isInactive is a property.

nlobjFile.isOnline()

File.isOnline

N/file Module

Note that isOnline is a property.

For a script sample, see N/file Module Script Samples.

nlobjFile.setDescription(description)

File.description

N/file Module

Note that description is a property.

nlobjFile.setEncoding(encodingType)

File.encoding

N/file Module

Note that encoding is a property.

nlobjFile.setFolder(id)

File.folder

N/file Module

Note that folder is a property.

You can also set the folder during file creation with file.create(options).

For a script sample, see N/file Module Script Samples.

nlobjFile.setIsInactive(inactive)

File.isInactive

N/file Module

Note that isInactive is a property.

nlobjFile.setIsOnline(online)

File.isOnline

N/file Module

Note that isOnline is a property.

For a script sample, see N/file Module Script Samples.

nlobjFile.setName(name)

File.name

N/file Module

Note that name is a property.

For a script sample, see N/file Module Script Samples.

nlobjForm

serverWidget.Form

N/ui/serverWidget Module

-

nlobjForm.addButton(name, label, script)

Form.addButton(options)

N/ui/serverWidget Module

-

nlobjForm.addCredentialField(id, label, website, scriptId, value, entityMatch, tab)

Form.addCredentialField(options)

N/ui/serverWidget Module

-

nlobjForm.addField(name, type, label, sourceOrRadio, tab)

Form.addField(options)

N/ui/serverWidget Module

For a script sample, see N/ui/serverWidget Module Script Samples

nlobjForm.addFieldGroup(name, label, tab)

Form.addFieldGroup(options)

N/ui/serverWidget Module

-

nlobjForm.addPageLink(type, title, url)

Form.addPageLink(options)

N/ui/serverWidget Module

-

nlobjForm.addSubList(name, type, label, tab)

Form.addSublist(options)

N/ui/serverWidget Module

For a script sample, see N/ui/serverWidget Module Script Samples

nlobjForm.addSubmitButton(label)

Form.addSubmitButton(options)

N/ui/serverWidget Module

For a script sample, see N/ui/serverWidget Module Script Samples

nlobjForm.addSubTab(name, label, tab)

Form.addSubtab(options)

N/ui/serverWidget Module

-

nlobjForm.addTab(name, label)

Form.addTab(options)

N/ui/serverWidget Module

-

nlobjForm.getButton(name)

Form.getButton(options)

N/ui/serverWidget Module

-

nlobjForm.getField(name, radio)

Form.getField(options)

N/ui/serverWidget Module

-

nlobjForm.getSubList(name)

Form.getSublist(options)

N/ui/serverWidget Module

-

nlobjForm.getSubTab(name)

Form.getSubtab(options)

N/ui/serverWidget Module

-

nlobjForm.getTab(name)

Form.getTab(options)

N/ui/serverWidget Module

-

nlobjForm.getTabs()

Form.getTabs()

N/ui/serverWidget Module

-

nlobjForm.insertField(field, nextfld)

Form.insertField(options)

N/ui/serverWidget Module

-

nlobjForm.insertSubList(sublist, nextsub)

Form.insertSublist(options)

N/ui/serverWidget Module

-

nlobjForm.insertSubTab(subtab, nextsub)

Form.insertSubtab(options)

N/ui/serverWidget Module

-

nlobjForm.insertTab(tab, nexttab)

Form.insertTab(options)

N/ui/serverWidget Module

-

nlobjForm.removeButton(name)

Form.removeButton(options)

N/ui/serverWidget Module

-

nlobjForm.setFieldValues(values)

Form.updateDefaultValues(options)

N/ui/serverWidget Module

-

nlobjForm.setScript(script)

Form.clientScriptFileId

Form.clientScriptModulePath

N/ui/serverWidget Module

Note that clientScriptFileId and clientScriptModulePath are properties.

Use one of these SuiteScript 2.x properties to attach an ad hoc client script to a form.

nlobjForm.setTitle(title)

Form.title

N/ui/serverWidget Module

Note that title is a property.

nlobjFuture

task.EntityDeduplicationTaskStatus

N/task Module

-

nlobjFuture.isCancelled()

EntityDeduplicationTaskStatus.status

N/task Module

Note that status is a property.

nlobjFuture.isDone()

EntityDeduplicationTaskStatus.status

N/task Module

Note that status is a property.

nlobjJobManager

task.EntityDeduplicationTaskStatus

N/task Module

-

nlobjJobManager.createJobRequest()

task.create(options)

N/task Module

-

nlobjJobManager.getFuture()

task.checkStatus(options)

N/task Module

-

nlobjJobManager.submit(nlobjDuplicateJobRequest)

EntityDeduplicationTask.submit()

N/task Module

-

nlobjList

serverWidget.List

N/ui/serverWidget Module

-

nlobjList.addButton(name, label, script)

List.addButton(options)

N/ui/serverWidget Module

-

nlobjList.addColumn(name, type, label, align)

List.addColumn(options)

N/ui/serverWidget Module

-

nlobjList.addEditColumn(column, showView, showHrefCol)

List.addEditColumn(options)

N/ui/serverWidget Module

-

nlobjList.addPageLink(type, title, url)

List.addPageLink(options)

N/ui/serverWidget Module

-

nlobjList.addRow(row)

List.addRow(options)

N/ui/serverWidget Module

-

nlobjList.addRows(rows)

List.addRows(options)

N/ui/serverWidget Module

-

nlobjList.setScript(script)

List.clientScriptFileId

List.clientScriptModulePath

N/ui/serverWidget Module

Note that clientScriptFileId and clientScriptModulePath are properties.

Use one of these SuiteScript 2.x properties to attach an ad hoc client script to a form.

nlobjList.setStyle(style)

List.style

N/ui/serverWidget Module

Note that style is a property.

nlobjList.setTitle(title)

List.title

N/ui/serverWidget Module

Note that title is a property.

nlobjLogin

See Notes.

N/auth Module

See nlobjLogin members.

nlobjLogin.changeEmail(currentPassword, newEmail, justThisAccount)

auth.changeEmail(options)

N/auth Module

For a script sample, see N/auth Module Script Sample.

nlobjLogin.changePassword(currentPassword, newPassword)

auth.changePassword(options)

N/auth Module

For a script sample, see N/auth Module Script Sample

nlobjMergeResult

render.EmailMergeResult

N/render Module

-

nlobjMergeResult.getBody()

EmailMergeResult.body

N/render Module

Note that body is a property.

nlobjMergeResult.getSubject()

EmailMergeResult.subject

N/render Module

Note that subject is a property.

nlobjPortlet

Portlet Object

See Notes

For additional information, see SuiteScript 2.x Portlet Script Type.

nlobjPortlet.addColumn(name, type, label, just)

Portlet.addColumn(options)

-

For additional information, see SuiteScript 2.x Portlet Script Type.

nlobjPortlet.addEditColumn(column, showView, showHrefCol)

Portlet.addEditColumn(options)

-

For additional information, see SuiteScript 2.x Portlet Script Type.

nlobjPortlet.addField(name, type, label, source)

Portlet.addField(options)

-

For additional information, see SuiteScript 2.x Portlet Script Type.

nlobjPortlet.addLine(text, url, indent)

Portlet.addLine(options)

-

For additional information, see SuiteScript 2.x Portlet Script Type.

nlobjPortlet.addRow(row)

Portlet.addRow(options)

-

For additional information, see SuiteScript 2.x Portlet Script Type.

nlobjPortlet.addRows(rows)

Portlet.addRows(options)

-

For additional information, see SuiteScript 2.x Portlet Script Type.

nlobjPortlet.setHtml(html)

Portlet.html

-

For additional information, see SuiteScript 2.x Portlet Script Type.

nlobjPortlet.setRefreshInterval(n)

-

-

There is no SuiteScript 2.x direct equivalent for this method.

For additional information, see SuiteScript 2.x Portlet Script Type.

nlobjPortlet.setScript(scriptid)

Portlet.clientScriptFileId

Portlet.clientScriptModulePath

-

For additional information, see SuiteScript 2.x Portlet Script Type.

nlobjPortlet.setSubmitButton(url, label, target)

Portlet.setSubmitButton(options)

-

For additional information, see SuiteScript 2.x Portlet Script Type.

nlobjPortlet.setTitle(title)

Portlet.title

-

For additional information, see SuiteScript 2.x Portlet Script Type.

nlobjRecord

record.Record

currentRecord.CurrentRecord

N/record Module

N/currentRecord Module

-

nlobjRecord.commitLineItem(group)

Record.commitLine(options)

CurrentRecord.commitLine(options)

N/record Module

N/currentRecord Module

-

nlobjRecord.createCurrentLineItemSubrecord(sublist, fldname)

Record.getCurrentSublistSubrecord(options)

CurrentRecord.getCurrentSublistSubrecord(options)

N/record Module

N/currentRecord Module

Note that scripting subrecords in SuiteScript 2.x is fundamentally different from scripting subrecords in SuiteScript 1.0. For additional information, see the SuiteScript 2.x topics under SuiteScript 2.x Scripting Subrecords.

nlobjRecord.createSubrecord(fldname)

Record.getSubrecord(options)

CurrentRecord.getSubrecord(options)

N/record Module

N/currentRecord Module

Note that scripting subrecords in SuiteScript 2.x is fundamentally different from scripting subrecords in SuiteScript 1.0. For additional information, see the SuiteScript 2.x topics under SuiteScript 2.x Scripting Subrecords.

nlobjRecord.editCurrentLineItemSubrecord(sublist, fldname)

Record.getCurrentSublistSubrecord(options)

CurrentRecord.getCurrentSublistSubrecord(options)

N/record Module

N/currentRecord Module

Note that scripting subrecords in SuiteScript 2.x is fundamentally different from scripting subrecords in SuiteScript 1.0. For additional information, see the SuiteScript 2.x topics under SuiteScript 2.x Scripting Subrecords.

nlobjRecord.editSubrecord(fldname)

Record.getSubrecord(options)

CurrentRecord.getSubrecord(options)

N/record Module

N/currentRecord Module

Note that scripting subrecords in SuiteScript 2.x is fundamentally different from scripting subrecords in SuiteScript 1.0. For additional information, see the SuiteScript 2.x topics under SuiteScript 2.x Scripting Subrecords.

nlobjRecord.findLineItemMatrixValue(group, fldnam, column, val)

Record.findMatrixSublistLineWithValue(options)

CurrentRecord.findMatrixSublistLineWithValue(options)

N/record Module

N/currentRecord Module

-

nlobjRecord.findLineItemValue(group, fldnam, value)

Record.findSublistLineWithValue(options)

CurrentRecord.findSublistLineWithValue(options)

N/record Module

N/currentRecord Module

-

nlobjRecord.getAllFields()

Record.getFields()

N/record Module

-

nlobjRecord.getAllLineItemFields(group)

Record.getSublistFields(options)

N/record Module

-

nlobjRecord.getCurrentLineItemDateTimeValue(type, fieldId, timeZone)

See Notes

N/format Module

Use the N/format module to mimic this functionality in SuiteScript 2.x.

nlobjRecord.getCurrentLineItemMatrixValue(group, fldnam, column)

Record.getCurrentMatrixSublistValue(options)

CurrentRecord.getCurrentMatrixSublistValue(options)

N/record Module

N/currentRecord Module

-

nlobjRecord.getCurrentLineItemValue(type, fldnam)

Record.getCurrentSublistValue(options)

CurrentRecord.getCurrentSublistValue(options)

N/record Module

N/currentRecord Module

-

nlobjRecord.getCurrentLineItemValues(type, fldname)

Record.getCurrentSublistValue(options)

CurrentRecord.getCurrentSublistValue(options)

N/record Module

N/currentRecord Module

Method returns an array for multi-select fields.

nlobjRecord.getDateTimeValue(fieldId, timeZone)

See Notes

N/format Module

Use the N/format module to mimic this functionality in SuiteScript 2.x.

nlobjRecord.getField(fldnam)

Record.getField(options)

CurrentRecord.getField(options)

N/record Module

N/currentRecord Module

-

nlobjRecord.getFieldText(name)

Record.getText(options)

CurrentRecord.getText(options)

N/record Module

N/currentRecord Module

-

nlobjRecord.getFieldTexts(name)

Record.getText(options)

CurrentRecord.getText(options)

N/record Module

N/currentRecord Module

-

nlobjRecord.getFieldValue(name)

Record.getValue(options)

CurrentRecord.getValue(options)

N/record Module

N/currentRecord Module

-

nlobjRecord.getFieldValues(name)

Record.getValue(options)

CurrentRecord.getValue(options)

N/record Module

N/currentRecord Module

-

nlobjRecord.getId()

Record.id

N/record Module

-

nlobjRecord.getLineItemCount()

Record.getLineCount(options)

N/record Module

-

nlobjRecord.getLineItemDateTimeValue(type, fieldId, lineNum, timeZone)

See Notes

N/format Module

Use the N/format module to mimic this functionality in SuiteScript 2.x.

nlobjRecord.getLineItemField(group, fldnam, linenum)

Record.getSublistField(options)

CurrentRecord.getSublistField(options)

N/record Module

N/currentRecord Module

-

nlobjRecord.getLineItemMatrixField(group, fldnam, linenum, column)

Record.getMatrixSublistField(options)

CurrentRecord.getMatrixSublistField(options)

N/record Module

N/currentRecord Module

-

nlobjRecord.getLineItemMatrixValue(group, fldnam, lineum, column)

Record.getMatrixSublistValue(options)

CurrentRecord.getMatrixSublistValue(options)

N/record Module

N/currentRecord Module

-

nlobjRecord.getLineItemText(group, fldnam, linenum)

Record.getSublistText(options)

CurrentRecord.getSublistText(options)

N/record Module

N/currentRecord Module

-

nlobjRecord.getLineItemValue(group, name, linenum)

Record.getSublistValue(options)

CurrentRecord.getSublistValue(options)

N/record Module

N/currentRecord Module

-

nlobjRecord.getLineItemValues(type, fldname, linenum)

Record.getSublistValue(options)

CurrentRecord.getSublistValue(options)

N/record Module

N/currentRecord Module

-

nlobjRecord.getMatrixCount(group, fldnam)

Record.getMatrixHeaderCount(options)

CurrentRecord.getMatrixHeaderCount(options)

N/record Module

N/currentRecord Module

-

nlobjRecord.getMatrixField(group, fldname, column)

Record.getMatrixHeaderField(options)

CurrentRecord.getMatrixHeaderField(options)

N/record Module

N/currentRecord Module

-

nlobjRecord.getMatrixValue(group, fldnam, column)

Record.getMatrixHeaderValue(options)

CurrentRecord.getMatrixHeaderValue(options)

N/record Module

N/currentRecord Module

-

nlobjRecord.getRecordType()

Record.type

N/record Module

-

nlobjRecord.insertLineItem(group, linenum)

Record.insertLine(options)

CurrentRecord.insertLine(options)

N/record Module

N/currentRecord Module

-

nlobjRecord.removeLineItem(group, linenum)

Record.removeLine(options)

CurrentRecord.removeLine(options)

N/record Module

N/currentRecord Module

-

nlobjRecord.removeCurrentLineItemSubrecord(sublist, fldname)

Record.removeCurrentSublistSubrecord(options)

N/record Module

N/currentRecord Module

Note that scripting subrecords in SuiteScript 2.x is fundamentally different from scripting subrecords in SuiteScript 1.0. For additional information, see the SuiteScript 2.x topics under SuiteScript 2.x Scripting Subrecords.

nlobjRecord.removeSubrecord(fldname)

Record.removeSubrecord(options)

CurrentRecord.removeSubrecord(options)

N/record Module

N/currentRecord Module

Note that scripting subrecords in SuiteScript 2.x is fundamentally different from scripting subrecords in SuiteScript 1.0. For additional information, see the SuiteScript 2.x topics under SuiteScript 2.x Scripting Subrecords.

nlobjRecord.selectLineItem(group, linenum)

Record.selectLine(options)

CurrentRecord.selectLine(options)

N/record Module

N/currentRecord Module

-

nlobjRecord.selectNewLineItem(group)

Record.selectNewLine(options)

CurrentRecord.selectNewLine(options)

N/record Module

N/currentRecord Module

-

nlobjRecord.setCurrentLineItemDateTimeValue(type, fieldId, dateTime, timeZone)

See Notes

N/format Module

Use the N/format module to mimic this functionality in SuiteScript 2.x.

nlobjRecord.setCurrentLineItemMatrixValue(group, fldnam, column, value)

Record.setCurrentMatrixSublistValue(options)

CurrentRecord.setCurrentMatrixSublistValue(options)

N/record Module

N/currentRecord Module

-

nlobjRecord.setCurrentLineItemValue(group, name, value)

Record.setCurrentSublistValue(options)

CurrentRecord.setCurrentSublistValue(options)

N/record Module

N/currentRecord Module

-

nlobjRecord.setDateTimeValue(fieldId, dateTime, timeZone)

See Notes

N/format Module

Use the N/format module to mimic this functionality in SuiteScript 2.x.

nlobjRecord.setFieldText(name, text)

Record.setText(options)

CurrentRecord.setText(options)

N/record Module

N/currentRecord Module

-

nlobjRecord.setFieldTexts(name, text)

Record.setText(options)

CurrentRecord.setText(options)

N/record Module

N/currentRecord Module

-

nlobjRecord.setFieldValue(name, value)

Record.setValue(options)

CurrentRecord.setValue(options)

N/record Module

N/currentRecord Module

-

nlobjRecord.setFieldValues(name, value)

Record.setValue(options)

CurrentRecord.setValue(options)

N/record Module

N/currentRecord Module

-

nlobjRecord.setLineItemDateTimeValue(type, fieldId, lineNum, dateTime, timeZone)

See Notes

N/format Module

Use the N/format module to mimic this functionality in SuiteScript 2.x.

nlobjRecord.setLineItemValue(group, name, linenum, value)

Record.setSublistValue(options)

N/record Module

-

nlobjRecord.setMatrixValue(group, fldnam, column, value)

Record.setMatrixHeaderValue(options)

CurrentRecord.setMatrixHeaderValue(options)

N/record Module

N/currentRecord Module

-

nlobjRecord.viewCurrentLineItemSubrecord(sublist, fldname)

Record.getCurrentSublistSubrecord(options)

CurrentRecord.getCurrentSublistSubrecord(options)

N/record Module

N/currentRecord Module

Note that scripting subrecords in SuiteScript 2.x is fundamentally different from scripting subrecords in SuiteScript 1.0. For additional information, see the SuiteScript 2.x topics under SuiteScript 2.x Scripting Subrecords.

nlobjRecord.viewLineItemSubrecord(sublist, fldname, linenum)

Record.getSublistSubrecord(options)

N/record Module

Note that scripting subrecords in SuiteScript 2.x is fundamentally different from scripting subrecords in SuiteScript 1.0. For additional information, see the SuiteScript 2.x topics under SuiteScript 2.x Scripting Subrecords.

nlobjRecord.viewSubrecord(fldname)

Record.getSubrecord(options)

CurrentRecord.getSubrecord(options)

N/record Module

N/currentRecord Module

Note that scripting subrecords in SuiteScript 2.x is fundamentally different from scripting subrecords in SuiteScript 1.0. For additional information, see the SuiteScript 2.x topics under SuiteScript 2.x Scripting Subrecords.

nlobjRequest

http.ServerRequest

N/http Module N/https Module

-

nlobjRequest.getAllHeaders()

ServerRequest.headers

N/http Module N/https Module

ServerRequest.headers(options) is read-only.

nlobjRequest.getAllParameters()

ServerRequest.parameters

N/http Module N/https Module

ServerRequest.parameters(options) is read-only.

nlobjRequest.getBody()

ServerRequest.body

N/http Module N/https Module

ServerRequest.body(options) is read-only.

nlobjRequest.getFile(id)

ServerRequest.files

N/http Module N/https Module

ServerRequest.files(options) is read-only.

nlobjRequest.getHeader(name)

ServerRequest.headers

N/http Module N/https Module

ServerRequest.headers)options) is read-only.

nlobjRequest.getLineItemCount(group)

ServerRequest.getLineCount(options)

N/http Module N/https Module

-

nlobjRequest.getLineItemValue(group, name, line)

ServerRequest.getSublistValue(options)

N/http Module N/https Module

-

nlobjRequest.getMethod()

ServerRequest.method

N/http Module N/https Module

ServerRequest.method(options) is read-only.

nlobjRequest.getParameter(name)

ServerRequest.parameters

N/http Module N/https Module

ServerRequest.parameters(options) is read-only.

nlobjRequest.getParameterValues(name)

ServerRequest.parameters

N/http Module N/https Module

ServerRequest.parameters(options) is read-only.

nlobjRequest.getURL()

ServerRequest.url

N/http Module N/https Module

ServerRequest.url is read-only.

nlobjResponse

http.ServerResponse

N/http Module N/https Module

-

nlobjResponse.addHeader(name, value)

ServerResponse.addHeader(options)

N/http Module N/https Module

-

nlobjResponse.getAllHeaders()

ServerResponse.getHeader(options) or

ServerResponse.headers

N/http Module N/https Module

-

nlobjResponse.getBody()

ClientResponse.body

N/http Module N/https Module

Note that ClientResponse.body is a property.

nlobjResponse.getCode()

ClientResponse.code

N/http Module N/https Module

Note that ClientResponse.code is a property.

nlobjResponse.getError()

See Notes

N/http Module N/https Module

There is no SuiteScript 2.x equivalent for this method.

nlobjResponse.getHeader(name)

ServerResponse.getHeader(options)

N/http Module N/https Module

-

nlobjResponse.getHeaders(name)

ServerResponse.getHeader(options)

N/http Module N/https Module

If multiple values are assigned to the header name. serverResponse.getHeader(options) returns the values as an Array.

nlobjResponse.renderPDF(xmlString)

ServerResponse.renderPdf(options)

N/http Module N/https Module

-

nlobjResponse.setCDNCacheable(type)

ServerResponse.setCdnCacheable(options)

N/http Module N/https Module

-

nlobjResponse.setContentType(type, name, disposition)

See Notes

N/http Module N/https Module

There is no direct equivalent for this method in SuiteScript 2.x.

nlobjResponse.setEncoding(encodingType)

See Notes

N/http Module N/https Module

There is no direct equivalent for this method in SuiteScript 2.x.

When you use https.ServerResponse, textual responses are encoded in UTF-8 by default. If you want to return a file with an alternative character encoding, see Return a File with Alternative Character Encoding.

nlobjResponse.setHeader(name, value)

ServerResponse.setHeader(options)

N/http Module N/https Module

-

nlobjResponse.sendRedirect(type, identifier, id, editmode, parameters)

ServerResponse.sendRedirect(options)

N/http Module N/https Module

-

nlobjResponse.write(output)

ServerResponse.write(options)

N/http Module N/https Module

-

nlobjResponse.writeLine(output)

ServerResponse.writeLine(options)

N/http Module N/https Module

-

nlobjResponse.writePage(pageobject)

ServerResponse.writePage(options)

N/http Module N/https Module

-

nlobjSearch

search.Search

N/search Module

-

nlobjSearch.addColumn(column)

Search.columns

N/search Module

Note that Search.columns is a property.

nlobjSearch.addColumns(columns)

Search.columns

N/search Module

Note that Search.columns is a property.

nlobjSearch.addFilter(filter)

Search.filters

N/search Module

Note that Search.filters is a property.

nlobjSearch.addFilters(filters)

Search.filters

N/search Module

Note that Search.filters is a property.

nlobjSearch.deleteSearch()

search.delete(options)

N/search Module

For a script sample, see N/search Module Script Samples.

nlobjSearch.getColumns()

Search.columns

N/search Module

Note that columns is a property.

nlobjSearch.getFilterExpression()

Search.filterExpression

N/search Module

Note that filterExpression is a property.

nlobjSearch.getFilters()

Search.filters

N/search Module

Note that filters is a property.

nlobjSearch.getId()

Search.searchId

N/search Module

Note that id is a property.

nlobjSearch.getIsPublic()

Search.isPublic

N/search Module

Note that isPublic is a property.

nlobjSearch.getScriptId()

Search.id

N/search Module

-

nlobjSearch.getSearchType()

Search.searchType

N/search Module

Note that searchType is a property.

nlobjSearch.runSearch()

Search.run()

N/search Module

-

nlobjSearch.saveSearch(title, scriptId)

Search.save()

N/search Module

-

nlobjSearch.setColumns(columns)

Search.columns

N/search Module

Note that columns is a property.

nlobjSearch.setFilterExpression(filterExpression)

Search.filterExpression

N/search Module

Note that filterExpression is a property.

nlobjSearch.setFilters(filters)

Search.filters

N/search Module

Note that filters is a property.

nlobjSearch.setIsPublic(type)

Search.isPublic

N/search Module

Note that isPublic is a property.

nlobjSearch.setRedirectURLToSearch()

redirect.toSavedSearch(options)

redirect.toSearch(options)

N/redirect Module

-

nlobjSearch.setRedirectURLToSearchResults()

redirect.toSearchResult(options)

redirect.toSavedSearchResult(options)

N/redirect Module

-

nlobjSearchColumn

search.Column

N/search Module

-

nlobjSearchFilter

search.Filter

N/search Module

-

nlobjSearchResult

search.Result

N/search Module

-

nlobjSearchResultSet

search.ResultSet

N/search Module

-

nlobjSelectOption

See Notes

N/record Module

See mapping for nlobjSelectOption methods.

nlobjSelectOption.getId()

N/record: Field.getSelectOptions(options)

N/currentRecord: Field.getSelectOptions(options)

N/record Module

N/currentRecord Module

-

nlobjSelectOption.getText()

N/record: Field.getSelectOptions(options)

N/currentRecord: Field.getSelectOptions(options)

N/record Module

N/currentRecord Module

-

nlobjSubList

serverWidget.Sublist

N/ui/serverWidget Module

-

nlobjSublist.addButton(name, label, script)

Sublist.addButton(options)

N/ui/serverWidget Module

-

nlobjSublist.addField(name, type, label, source)

Sublist.addField(options)

N/ui/serverWidget Module

-

nlobjSublist.addMarkAllButtons()

Sublist.addMarkAllButtons()

N/ui/serverWidget Module

-

nlobjSublist.addRefreshButton()

Sublist.addRefreshButton()

N/ui/serverWidget Module

-

nlobjSublist.getLineItemCount()

Sublist.lineCount

N/ui/serverWidget Module

Note that lineCount is a property

nlobjSublist.getLineItemValue(group, fldnam, linenum)

Sublist.getSublistValue(options)

N/ui/serverWidget Module

-

nlobjSublist.setAmountField(field)

Sublist.updateTotallingFieldId(options)

N/ui/serverWidget Module

-

nlobjSublist.setDisplayType(type)

Sublist.displayType

N/ui/serverWidget Module

Note that displayType is a property

nlobjSublist.setHelpText(help)

Sublist.helpText

N/ui/serverWidget Module

Note that helpText is a property

nlobjSublist.setLabel(label)

Sublist.label

N/ui/serverWidget Module

Note that label is a property

nlobjSublist.setLineItemValue(name, linenum,value)

Sublist.setSublistValue(options)

N/ui/serverWidget Module

-

nlobjSublist.setLineItemValues(values)

See Notes

N/ui/serverWidget Module

There is not a SuiteScript 2.x direct equivalent for this method.

nlobjSublist.setUniqueField(name)

Sublist.updateUniqueFieldId(options)

N/ui/serverWidget Module

Note that uniqueFieldId is a property

nlobjSubrecord

See Notes

N/record Module

SuiteScript 2.x subrecords are returned as record.Record objects.

Note that scripting subrecords in SuiteScript 2.x is fundamentally different from scripting subrecords in SuiteScript 1.0. For additional information, see the SuiteScript 2.x topics under SuiteScript 2.x Scripting Subrecords.

nlobjSubrecord.cancel()

See Notes

N/record Module

SuiteScript 2.x subrecords are returned as record.Record objects.

Note that scripting subrecords in SuiteScript 2.x is fundamentally different from scripting subrecords in SuiteScript 1.0. For additional information, see the SuiteScript 2.x topics under SuiteScript 2.x Scripting Subrecords.

nlobjSubrecord.commit()

See Notes

N/record Module

This API does not have a SuiteScript 2.x equivalent. SuiteScript 2.x subrecords are returned as record.Record objects.

Note that scripting subrecords in SuiteScript 2.x is fundamentally different from scripting subrecords in SuiteScript 1.0. For additional information, see the SuiteScript 2.x topics under SuiteScript 2.x Scripting Subrecords.

nlobjTab

serverWidget.Tab

N/ui/serverWidget Module

-

nlobjTab.setLabel(label)

Tab.label

N/ui/serverWidget Module

Note that label is a property

nlobjTab.setHelpText(help)

Tab.helpText

N/ui/serverWidget Module

Note that helpText is a property

nlobjTemplateRenderer

render.TemplateRenderer

N/render Module

For a script sample, see N/render Module Script Samples.

nlobjTemplateRenderer.addRecord(var, record)

TemplateRenderer.addRecord(options)

N/render Module

For a script sample, see N/render Module Script Samples.

nlobjTemplateRenderer.addSearchResults(var, searchResult)

TemplateRenderer.addSearchResults(options)

N/render Module

For a script sample, see N/render Module Script Samples.

nlobjTemplateRenderer.renderToResponse()

TemplateRenderer.renderToResponse(options)

N/render Module

-

nlobjTemplateRenderer.renderToString()

TemplateRenderer.renderAsString()

N/render Module

-

nlobjTemplateRenderer.setTemplate()

TemplateRenderer.templateContent

N/render Module

For a script sample, see N/render Module Script Samples.