Skip to content

Commit dd3253e

Browse files
sujaygarlankasujaygarlanka
authored
Add marker-based pagination for getting users (#454)
1 parent 743d68c commit dd3253e

File tree

110 files changed

+1089
-126
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

110 files changed

+1089
-126
lines changed

‎CHANGELOG.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Changelog
22

3+
## Upcoming Release
4+
5+
- Added a getter method (getNextMarker()) for the next marker to PagingIterator
6+
37
## 1.30.0 [2019-11-21]
48

59
- Deprecated Batch API methods

‎docs/enterprise.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@ Get Enterprise Users
1818

1919
Get a list of users in the current enterprise by calling the
2020
[`enterprise.getUsers(options, callback)`](http://opensource.box.com/box-node-sdk/jsdoc/Enterprise.html#getUsers)
21-
method.
21+
method. This method supports offset-based pagination and marker-based pagintation. To use offset-based pagination, do not pass in the `usemarker` parameter or set it to `false`. To use marker-based pagination, pass in the `usemarker` parameter as `true`. Use the `fields` option to specify the desired response fields, and `limit` (along with `offset` or `marker`) to control result set paging. Requesting information for only the fields you need can improve performance by reducing the size of the network response.
2222

2323
<!-- sample get_users -->
2424
```js
25-
client.enterprise.getUsers()
25+
client.enterprise.getUsers({usemarker: true, marker: 'JFUirotE56hfyr56FH123'})
2626
.then(users => {
2727
/* users -> {
2828
total_count: 1,

‎docs/folders.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -119,14 +119,14 @@ Get a Folder's Items
119119

120120
Folder items can be retrieved by calling the
121121
[`folders.getItems(folderID, options, callback)`](http://opensource.box.com/box-node-sdk/jsdoc/Folders.html#getItems)
122-
method. Use the `fields` option to specify the desired fields, and `limit` and `offset` to control result set paging.
123-
Requesting information for only the fields you need can improve performance and reduce the size of the network request.
122+
method. This method supports offset-based pagination and marker-based pagination. To use offset-based pagination, do not pass in the `usemarker` parameter or set it to `false`. To use marker-based pagination, pass in the `usemarker` parameter as `true`. Use the `fields` option to specify the desired fields, and `limit` and (`offset` or `marker`) to control result set paging. Requesting information for only the fields you need can improve performance by reducing the size of the network response.
124123

125124
<!-- sample get_folders_id_items -->
126125
```js
127126
client.folders.getItems(
128127
'12345',
129128
{
129+
usemarker: 'false',
130130
fields: 'name',
131131
offset: 0,
132132
limit: 25

‎docs/jsdoc/APIRequest.html‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -194,6 +194,8 @@ <h5>Parameters:</h5>
194194

195195

196196

197+
198+
197199

198200
</div>
199201

@@ -359,6 +361,8 @@ <h5>Parameters:</h5>
359361

360362

361363

364+
365+
362366
<h5>Returns:</h5>
363367

364368

@@ -464,6 +468,8 @@ <h4 class="name" id="getResponseStream"><span class="type-signature"></span>getR
464468

465469

466470

471+
472+
467473
<h5>Returns:</h5>
468474

469475

@@ -678,6 +684,8 @@ <h5>Parameters:</h5>
678684

679685

680686

687+
688+
681689

682690

683691
<h4 class="name" id="~Error">Error</h4>
@@ -1327,7 +1335,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-bo
13271335
<br class="clear">
13281336

13291337
<footer>
1330-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Nov 21 2019 11:48:29 GMT-0800 (Pacific Standard Time)
1338+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Wed Jan 08 2020 13:26:05 GMT-0800 (Pacific Standard Time)
13311339
</footer>
13321340

13331341
<script> prettyPrint(); </script>

‎docs/jsdoc/APIRequestManager.html‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -193,6 +193,8 @@ <h5>Parameters:</h5>
193193

194194

195195

196+
197+
196198

197199
</div>
198200

@@ -343,6 +345,8 @@ <h5>Parameters:</h5>
343345

344346

345347

348+
349+
346350
<h5>Returns:</h5>
347351

348352

@@ -500,6 +504,8 @@ <h5>Parameters:</h5>
500504

501505

502506

507+
508+
503509
<h5>Returns:</h5>
504510

505511

@@ -549,7 +555,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-bo
549555
<br class="clear">
550556

551557
<footer>
552-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Nov 21 2019 11:48:29 GMT-0800 (Pacific Standard Time)
558+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Wed Jan 08 2020 13:26:05 GMT-0800 (Pacific Standard Time)
553559
</footer>
554560

555561
<script> prettyPrint(); </script>

‎docs/jsdoc/AnonymousSession.html‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -201,6 +201,8 @@ <h5>Parameters:</h5>
201201

202202

203203

204+
205+
204206

205207
</div>
206208

@@ -431,6 +433,8 @@ <h5>Parameters:</h5>
431433

432434

433435

436+
437+
434438
<h5>Returns:</h5>
435439

436440

@@ -603,6 +607,8 @@ <h5>Parameters:</h5>
603607

604608

605609

610+
611+
606612
<h5>Returns:</h5>
607613

608614

@@ -760,6 +766,8 @@ <h5>Parameters:</h5>
760766

761767

762768

769+
770+
763771
<h5>Returns:</h5>
764772

765773

@@ -809,7 +817,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-bo
809817
<br class="clear">
810818

811819
<footer>
812-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Nov 21 2019 11:48:28 GMT-0800 (Pacific Standard Time)
820+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Wed Jan 08 2020 13:26:05 GMT-0800 (Pacific Standard Time)
813821
</footer>
814822

815823
<script> prettyPrint(); </script>

‎docs/jsdoc/AppAuthSession.html‎

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -315,6 +315,8 @@ <h5>Parameters:</h5>
315315

316316

317317

318+
319+
318320

319321
</div>
320322

@@ -638,6 +640,8 @@ <h6>Properties</h6>
638640

639641

640642

643+
644+
641645
<h5>Returns:</h5>
642646

643647

@@ -810,6 +814,8 @@ <h5>Parameters:</h5>
810814

811815

812816

817+
818+
813819
<h5>Returns:</h5>
814820

815821

@@ -969,6 +975,8 @@ <h5>Parameters:</h5>
969975

970976

971977

978+
979+
972980
<h5>Returns:</h5>
973981

974982

@@ -1140,6 +1148,8 @@ <h5>Parameters:</h5>
11401148

11411149

11421150

1151+
1152+
11431153
<h5>Returns:</h5>
11441154

11451155

@@ -1189,7 +1199,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-bo
11891199
<br class="clear">
11901200

11911201
<footer>
1192-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Nov 21 2019 11:48:29 GMT-0800 (Pacific Standard Time)
1202+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Wed Jan 08 2020 13:26:05 GMT-0800 (Pacific Standard Time)
11931203
</footer>
11941204

11951205
<script> prettyPrint(); </script>

‎docs/jsdoc/BasicSession.html‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -199,6 +199,8 @@ <h5>Parameters:</h5>
199199

200200

201201

202+
203+
202204

203205
</div>
204206

@@ -522,6 +524,8 @@ <h6>Properties</h6>
522524

523525

524526

527+
528+
525529
<h5>Returns:</h5>
526530

527531

@@ -631,6 +635,8 @@ <h4 class="name" id="getAccessToken"><span class="type-signature"></span>getAcce
631635

632636

633637

638+
639+
634640
<h5>Returns:</h5>
635641

636642

@@ -800,6 +806,8 @@ <h5>Parameters:</h5>
800806

801807

802808

809+
810+
803811
<h5>Returns:</h5>
804812

805813

@@ -849,7 +857,7 @@ <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-bo
849857
<br class="clear">
850858

851859
<footer>
852-
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Thu Nov 21 2019 11:48:29 GMT-0800 (Pacific Standard Time)
860+
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Wed Jan 08 2020 13:26:05 GMT-0800 (Pacific Standard Time)
853861
</footer>
854862

855863
<script> prettyPrint(); </script>

0 commit comments

Comments
 (0)