RequestParameters
Extends:
Used for keeping track of the request parameters
Static Member Summary
Static Public Members | ||
public static get |
Default deleted items filter state |
|
public static set |
Default deleted items filter state |
|
public static get |
Default extra request parameters |
|
public static set |
Default extra request parameters |
|
public static get |
maxPerPage: Number: * Gets the maximum allowed value for perPage Some users will have a special permission that allows them to fetch more than 50 resources at once |
|
public static set |
maxPerPage(value: Number) Sets the maximum allowed value for perPage Some users will have a special permission that allows them to fetch more than 50 resources at once |
|
public static get |
Default pagination offset |
|
public static set |
Default pagination offset |
|
public static get |
Default page number |
|
public static set |
Default page number |
|
public static get |
Default per page |
|
public static set |
Default per page |
|
public static get |
Default search query |
|
public static set |
Default search query |
|
public static get |
Default sort query |
|
public static set |
Default sort query |
Static Method Summary
Static Public Methods | ||
public static |
Different parameters |
|
public static |
Resets all parameters back to default |
Constructor Summary
Public Constructor | ||
public |
constructor(object: Object) RequestParameters constructor |
Member Summary
Public Members | ||
public get |
If deleted items should be shown |
|
public set |
Deleted items filter state |
|
public get |
Extra parameters |
|
public set |
Extra request parameters |
|
public get |
Get pagination offset |
|
public set |
Pagination offset |
|
public get |
Get page number |
|
public set |
Page number |
|
public get |
Get rows per page |
|
public set |
Rows per page |
|
public get |
Search query |
|
public set |
Search query |
|
public get |
Get sort options |
|
public set |
Sort query |
Method Summary
Public Methods | ||
public |
apply(params: object | RequestParameters): Object[] Apply parameters from object |
|
public |
Copy object |
|
public |
Urlencode parameters |
|
public |
Convert to object |
|
public |
Convert to object |
|
public |
Generates a cache token |
Static Public Members
public static get maxPerPage: Number: * source
Gets the maximum allowed value for perPage Some users will have a special permission that allows them to fetch more than 50 resources at once
public static set maxPerPage(value: Number) source
Sets the maximum allowed value for perPage Some users will have a special permission that allows them to fetch more than 50 resources at once
Static Public Methods
Public Constructors
Public Members
Public Methods
public apply(params: object | RequestParameters): Object[] source
Apply parameters from object
Params:
Name | Type | Attribute | Description |
params | object | RequestParameters | parameters |
Example:
const params = new RequestParameters({perPage: 12});
params.perPage === 12;
params.apply({perPage: 50});
params.perPage === 50;