new nlobjAssistantStep() → {nlobjAssistantStep}
Return a new instance of nlobjAssistantStep.
- Since:
- 2009.2
- Source:
- nlapihandler_stubs.js, line 4640
Returns:
- Type
- nlobjAssistantStep
Methods
-
getAllFields() → {string[]}
-
return an array of the names of all fields entered by the user during this step.
- Since:
- 2009.2
- Source:
- nlapihandler_stubs.js, line 4736
Returns:
- Type
- string[]
-
getAllLineItemFields(group) → {string[]}
-
return an array of the names of all sublist fields entered by the user during this step
Parameters:
Name Type Description group
string sublist name - Since:
- 2009.2
- Source:
- nlapihandler_stubs.js, line 4759
Returns:
- Type
- string[]
-
getAllLineItems() → {string[]}
-
return an array of the names of all sublists entered by the user during this step.
- Since:
- 2009.2
- Source:
- nlapihandler_stubs.js, line 4747
Returns:
- Type
- string[]
-
getFieldValue(name) → {string}
-
return the value of a field entered by the user during this step.
Parameters:
Name Type Description name
string field name - Since:
- 2009.2
- Source:
- nlapihandler_stubs.js, line 4687
Returns:
- Type
- string
-
getFieldValues(name) → {string[]}
-
return the selected values of a multi-select field as an Array entered by the user during this step.
Parameters:
Name Type Description name
string multi-select field name - Since:
- 2009.2
- Source:
- nlapihandler_stubs.js, line 4699
Returns:
- Type
- string[]
-
getLineItemCount(group) → {int}
-
return the number of lines previously entered by the user in this step (or -1 if the sublist does not exist).
Parameters:
Name Type Description group
string sublist name - Since:
- 2009.2
- Source:
- nlapihandler_stubs.js, line 4711
Returns:
- Type
- int
-
getLineItemValue(group, name, line) → {string}
-
return the value of a sublist field entered by the user during this step.
Parameters:
Name Type Description group
string sublist name name
string sublist field name line
int sublist (1-based) - Since:
- 2009.2
- Source:
- nlapihandler_stubs.js, line 4725
Returns:
- Type
- string
-
getStepNumber() → {int}
-
return the index of this step in the assistant page (1-based)
- Since:
- 2009.2
- Source:
- nlapihandler_stubs.js, line 4675
Returns:
the index of this step in the assistant (1-based) based on the order in which the steps were added.- Type
- int
-
setHelpText(help) → {nlobjAssistantStep}
-
set helper text for this assistant step.
Parameters:
Name Type Description help
string inline help text to display on assistant page for this step - Since:
- 2009.2
- Source:
- nlapihandler_stubs.js, line 4664
Returns:
- Type
- nlobjAssistantStep
-
setLabel(label) → {void}
-
set the label for this assistant step.
Parameters:
Name Type Description label
string display label used for this assistant step - Since:
- 2009.2
- Source:
- nlapihandler_stubs.js, line 4652
Returns:
- Type
- void