new module:models/ResultPage()
Constructs a new ResultPage.
Data that can be used to get the next and previous page of a Data API results object.
- Source:
Members
(inner) count :Number
The number of returned documents.
Type:
- Number
- Source:
(inner) db_start_record_ :Number
The zero-based index of the record that we want to start with, used to optimize special handling
Type:
- Number
- Source:
(inner) start :Number
The zero-based index of the first search hit to include in the result.
Type:
- Number
- Source:
Methods
(static) constructFromObject(data, obj) → {module:models/ResultPage}
Constructs a ResultPage from a plain JavaScript object, optionally creating a new instance.
Copies all relevant properties from data to obj if supplied or a new instance if not.
Parameters:
| Name | Type | Description |
|---|---|---|
data |
Object | The plain JavaScript object bearing properties of interest. |
obj |
module:models/ResultPage | Optional instance to populate. |
- Source:
Returns:
The populated ResultPage instance.