Add marker based pagination for get users methods by sujaygarlanka · Pull Request #759 · box/box-java-sdk

sujaygarlanka · 2019-12-12T03:20:04Z

Issue Link 🔗

https://jira.inside-box.net/browse/SDK-1213

Goals ⚽

Add marker based pagination for get users methods

Implementation Details 🚧

Added usemarker and marker parameters to multiple get users methods
Updated BoxResourceIterable to be able to pass in marker to start pagination
Updated BoxResourceIterable to expose the next marker string

Testing Details 🔍

Unit testing
Manual testing

boxcla · 2019-12-12T03:20:08Z

Verified that @sujaygarlanka has signed the CLA. Thanks for the pull request!

… into users-marker-pagination merging changelog

PJSimon · 2019-12-13T22:27:31Z

+[`getAllEnterpriseUsers(BoxAPIConnection api, boolean usemarker, String marker)`][get-all-enterprise-users],
+[`getAllEnterpriseUsers(BoxAPIConnection api, String filterTerm, boolean usemarker, String marker, String... fields)`][get-all-enterprise-users-2], or
+[`getAllEnterpriseOrExternalUsers(BoxAPIConnection api, String filterTerm, boolean usemarker, String marker, String... fields)`][get-all-enterprise-users-3] method.
+To do marker pagination without passing in a marker, set the marker as `null`. In order to get the next marker, you must cast the iterable to `BoxResourseIterable<BoxUser.info>`


Suggested change

To do marker pagination without passing in a marker, set the marker as `null`. In order to get the next marker, you must cast the iterable to `BoxResourseIterable<BoxUser.info>`

To get the first page of results, set the `String marker` parameter to `null`. In order to get the next page of results, you must first cast the returned object to `BoxResourseIterable<BoxUser.info>`

PJSimon · 2019-12-13T22:29:47Z

+[`getAllEnterpriseUsers(BoxAPIConnection api, String filterTerm, boolean usemarker, String marker, String... fields)`][get-all-enterprise-users-2], or
+[`getAllEnterpriseOrExternalUsers(BoxAPIConnection api, String filterTerm, boolean usemarker, String marker, String... fields)`][get-all-enterprise-users-3] method.
+To do marker pagination without passing in a marker, set the marker as `null`. In order to get the next marker, you must cast the iterable to `BoxResourseIterable<BoxUser.info>`
+and call `getNextMarker()` on that iterable.


Suggested change

and call `getNextMarker()` on that iterable.

and call `getNextMarker()` on that object to get the next page's marker. Then, this marker can be set to the `String marker` parameter to get the next page of results, if there are any. If the marker returned from `getNextMarker()` is null, then there are no more pages of results.

PJSimon · 2019-12-13T22:34:42Z

+Iterable<BoxUser.Info> users = BoxUser.getAllEnterpriseUsers(api, true, null);
+
+// Get marker
+((BoxResourceIterable<BoxUser.Info>) users).getNextMarker();


Suggested change

((BoxResourceIterable<BoxUser.Info>) users).getNextMarker();

String marker = ((BoxResourceIterable<BoxUser.Info>) users).getNextMarker();

// Get next page

users = BoxUser.getAllEnterpriseUsers(api, true, marker);

PJSimon · 2019-12-13T22:36:40Z

+To get app user using external app user ID, call the
+[`getAppUsersByExternalAppUserID(BoxAPIConnection api, String externalID, boolean usemarker, String marker, String... fields)`][get-app-users-by-external-app-user-id].
+This method allows you to easily associate Box app users with your application's
+identifiers for those users. To do marker pagination without passing in a marker, set the marker as `null`. In order to get the next marker, you must cast the iterable to `BoxResourseIterable<BoxUser.info>` 


Suggested change

identifiers for those users. To do marker pagination without passing in a marker, set the marker as `null`. In order to get the next marker, you must cast the iterable to `BoxResourseIterable<BoxUser.info>`

identifiers for those users. To get the first page of results, set the `String marker` parameter to `null`. In order to get the next page of results, you must first cast the returned object to `BoxResourseIterable<BoxUser.info>`

PJSimon · 2019-12-13T22:37:04Z

+[`getAppUsersByExternalAppUserID(BoxAPIConnection api, String externalID, boolean usemarker, String marker, String... fields)`][get-app-users-by-external-app-user-id].
+This method allows you to easily associate Box app users with your application's
+identifiers for those users. To do marker pagination without passing in a marker, set the marker as `null`. In order to get the next marker, you must cast the iterable to `BoxResourseIterable<BoxUser.info>` 
+and call `getNextMarker()` on that iterable.


Suggested change

and call `getNextMarker()` on that iterable.

and call `getNextMarker()` on that object to get the next page's marker. Then, this marker can be set to the `String marker` parameter to get the next page of results, if there are any. If the marker returned from `getNextMarker()` is null, then there are no more pages of results.

Co-Authored-By: Patrick Simon <patrick@box.com>

PJSimon

Two small edits, other wise, APPROVED!

Co-Authored-By: Patrick Simon <patrick@box.com>

coveralls · 2019-12-14T03:17:43Z

Pull Request Test Coverage Report for Build 2019

26 of 39 (66.67%) changed or added relevant lines in 2 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage increased (+0.01%) to 65.26%

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
src/main/java/com/box/sdk/BoxResourceIterable.java	10	11	90.91%
src/main/java/com/box/sdk/BoxUser.java	16	28	57.14%

Totals
Change from base Build 2002:	0.01%
Covered Lines:	5352
Relevant Lines:	8201

💛 - Coveralls

working iterator, tests still need to pass

b583a31

sujaygarlanka added 4 commits December 11, 2019 19:23

Update CHANGELOG.md

13624b7

marker pagination tests passing and docs updated

8f73b28

Merge branch 'users-marker-pagination' of github.com:box/box-java-sdk…

7c4d355

… into users-marker-pagination merging changelog

small formatting change

0452cf6

PJSimon reviewed Dec 13, 2019

View reviewed changes

sujaygarlanka and others added 2 commits December 13, 2019 15:49

Update doc/users.md

c23739b

Co-Authored-By: Patrick Simon <patrick@box.com>

Update users.md

776ad56

PJSimon approved these changes Dec 14, 2019

View reviewed changes

sujaygarlanka added 4 commits December 13, 2019 16:39

Update BoxUser.java

993176f

Update BoxResourceIterable.java

d613ac1

Update BoxUser.java

eb5dd7c

Update BoxUser.java

75baed5

PJSimon reviewed Dec 14, 2019

View reviewed changes

Comment thread src/main/java/com/box/sdk/BoxResourceIterable.java Outdated

PJSimon reviewed Dec 14, 2019

View reviewed changes

Comment thread src/main/java/com/box/sdk/BoxResourceIterable.java Outdated

PJSimon reviewed Dec 14, 2019

View reviewed changes

sujaygarlanka and others added 3 commits December 13, 2019 19:14

Update BoxFileVersionRetentionTest.java

92250b3

Update src/main/java/com/box/sdk/BoxResourceIterable.java

edc650b

Co-Authored-By: Patrick Simon <patrick@box.com>

Update src/main/java/com/box/sdk/BoxResourceIterable.java

51965be

Co-Authored-By: Patrick Simon <patrick@box.com>

PJSimon approved these changes Dec 14, 2019

View reviewed changes

sujaygarlanka merged commit f16869e into master Dec 16, 2019

sujaygarlanka deleted the users-marker-pagination branch December 16, 2019 18:44

Navigation Menu

Uh oh!

Add marker based pagination for get users methods - #759

Add marker based pagination for get users methods#759
sujaygarlanka merged 14 commits into
masterfrom
users-marker-pagination

sujaygarlanka commented Dec 12, 2019

Uh oh!

boxcla commented Dec 12, 2019

Uh oh!

Uh oh!

PJSimon Dec 13, 2019

Uh oh!

PJSimon Dec 13, 2019

Uh oh!

PJSimon Dec 13, 2019

Uh oh!

PJSimon Dec 13, 2019

Uh oh!

PJSimon Dec 13, 2019

Uh oh!

Uh oh!

Uh oh!

Uh oh!

PJSimon left a comment

Uh oh!

coveralls commented Dec 14, 2019 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

	To do marker pagination without passing in a marker, set the marker as `null`. In order to get the next marker, you must cast the iterable to `BoxResourseIterable<BoxUser.info>`
	To get the first page of results, set the `String marker` parameter to `null`. In order to get the next page of results, you must first cast the returned object to `BoxResourseIterable<BoxUser.info>`

	and call `getNextMarker()` on that iterable.
	and call `getNextMarker()` on that object to get the next page's marker. Then, this marker can be set to the `String marker` parameter to get the next page of results, if there are any. If the marker returned from `getNextMarker()` is null, then there are no more pages of results.

-((BoxResourceIterable<BoxUser.Info>) users).getNextMarker();
+String marker = ((BoxResourceIterable<BoxUser.Info>) users).getNextMarker();
+// Get next page
+users = BoxUser.getAllEnterpriseUsers(api, true, marker);

	identifiers for those users. To do marker pagination without passing in a marker, set the marker as `null`. In order to get the next marker, you must cast the iterable to `BoxResourseIterable<BoxUser.info>`
	identifiers for those users. To get the first page of results, set the `String marker` parameter to `null`. In order to get the next page of results, you must first cast the returned object to `BoxResourseIterable<BoxUser.info>`

Uh oh!

Conversation

sujaygarlanka commented Dec 12, 2019

Issue Link 🔗

Goals ⚽

Implementation Details 🚧

Testing Details 🔍

Uh oh!

boxcla commented Dec 12, 2019

Uh oh!

Uh oh!

PJSimon Dec 13, 2019

Choose a reason for hiding this comment

Uh oh!

PJSimon Dec 13, 2019

Choose a reason for hiding this comment

Uh oh!

PJSimon Dec 13, 2019

Choose a reason for hiding this comment

Uh oh!

PJSimon Dec 13, 2019

Choose a reason for hiding this comment

Uh oh!

PJSimon Dec 13, 2019

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

PJSimon left a comment

Choose a reason for hiding this comment

Uh oh!

coveralls commented Dec 14, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Test Coverage Report for Build 2019

💛 - Coveralls

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

coveralls commented Dec 14, 2019 •

edited

Loading