yv01p/Umbraco-CMS
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated documentation + default values for getPagedDescendants

Browse Source 
Changed type in example, from unknown "Content" to known "Document". 

Also changed the default values to show the first page, with a 100 results, instead the 100th page with 1 result.
This commit is contained in:
Søren Gregersen
2018-03-28 11:00:35 +02:00
committed by GitHub
parent 716020602d
commit a623e4034c
1 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
src/Umbraco.Web.UI.Client/src/common/resources/entity.resource.js
View File

@@ -406,7 +406,7 @@ function entityResource($q, $http, umbRequestHelper) {
*
* ##usage
* <pre>
* entityResource.getPagedDescendants(1234, "Content", {pageSize: 10, pageNumber: 2})
* entityResource.getPagedDescendants(1234, "Document", {pageSize: 10, pageNumber: 2})
* .then(function(contentArray) {
* var children = contentArray;
* alert('they are here!');
@@ -416,8 +416,8 @@ function entityResource($q, $http, umbRequestHelper) {
* @param {Int} parentid id of content item to return descendants of
* @param {string} type Object type name
* @param {Object} options optional options object
* @param {Int} options.pageSize if paging data, number of nodes per page, default = 1
* @param {Int} options.pageNumber if paging data, current page index, default = 100
* @param {Int} options.pageSize if paging data, number of nodes per page, default = 100
* @param {Int} options.pageNumber if paging data, current page index, default = 1
* @param {String} options.filter if provided, query will only return those with names matching the filter
* @param {String} options.orderDirection can be `Ascending` or `Descending` - Default: `Ascending`
* @param {String} options.orderBy property to order items by, default: `SortOrder`
@@ -427,8 +427,8 @@ function entityResource($q, $http, umbRequestHelper) {
getPagedDescendants: function (parentId, type, options) {
var defaults = {
pageSize: 1,
pageNumber: 100,
pageSize: 100,
pageNumber: 1,
filter: '',
orderDirection: "Ascending",
orderBy: "SortOrder"