This function returns an object containing information about the user's progress in the current interview.
JavaScript API: DirectAssembly: api.js Version: 1.0.0.0 (1.0.0.0)
Return Value
Type:
objectInformation about the user's progress in the current interview.
The returned progress object has three properties, all of them numbers:
| Property | Description |
|---|
| Answered |
The number of answered questions, not counting answers to optional questions
|
| Total |
The total number of questions in the interview (not counting optional questions)
|
| State |
A number indicating the state of the interview as a whole.
- 0: Interview is complete. If the interview progress bar were visible and had the default styling applied,
this would correspond to a green, fully complete progress bar.
- 1: Interview is incomplete. If the interview progress bar were visible and had the default styling applied,
this would correspond to a blue progress bar in an empty or partially-complete state.
- 2: Interview is incomplete, and one or more of the unanswered questions are required before
the user is allowed to progress further. If the interview progress bar were visible and had the default
styling applied, this is one of two states that would display a red progress bar.
- 3: The interview contains a dialog with an error message, which prevents the user from progressing.
If the interview progress bar were visible and had the default styling applied, this is one of two states that would
display a red progress bar.
- 4: The interview is incomplete, there is one or more required unanswered question, and a dialog contains an error message.
Because of this state, the user cannot progress further in the interview. If the interview progress bar were visible and had the
default styling applied, this is one of two states that would display a red progress bar.
|
This function was introduced in HotDocs Server 11.
Reference