RMP_IncludedCollection
Included collections are non-visible components used to get, save, remove, and update objects in collections.
Methods
aggregateCallback(pipelines, options, callbackSuccess, callbackFailure)
Performs an aggregation operation on the collection.
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
| pipelines | object | Array of pipelines to be executed | |
| options | object | Options to be used in the call | |
| mode | string | Execution mode of the collection (TEST or LIVE); defaults to the current execution mode of the application | |
| nb | number | Number of objects to be returned (max. 1000); used to paginate the results | |
| first | number | Index of the first object to be returned; used to paginate the results | |
| orderby | array | Array of fields by which to order the results, e.g. ["name", "lastname"]. A $sort pipeline will be appended to the given pipelines. | |
| order | array | Array of orders to be used to sort the results; for each orderby one order is required, e.g. ["asc","desc"] | |
| detailed | boolean | true to get a detailed result (including count, limit, and skip values) | |
| onSuccess | RMP_IncludedCollection~callbackSuccess | Callback function called in case of success | |
| onSuccess | RMP_IncludedCollection~callbackSuccess | allback function called in case of success |
detailed boolean