Add cursor parameter to reactions.list API method (#997)

Author: seratch

json-logs/samples/api/reactions.list.json

@@ -1061,8 +1061,7 @@
         "reply_users_count": 12345,
         "latest_reply": "0000000000.000000",
         "reply_users": [
-          "B00000000",
-          "U00000000"
+          "B00000000"
         ],
         "subscribed": false,
         "subtype": "",
@@ -1082,5 +1081,8 @@
   },
   "error": "",
   "needed": "",
-  "provided": ""
+  "provided": "",
+  "response_metadata": {
+    "next_cursor": ""
+  }
 }

slack-api-client/src/main/java/com/slack/api/methods/RequestFormBuilder.java

@@ -2043,6 +2043,7 @@ public static FormBody.Builder toForm(ReactionsListRequest req) {
         setIfNotNull("count", req.getCount(), form);
         setIfNotNull("page", req.getPage(), form);
         setIfNotNull("limit", req.getLimit(), form);
+        setIfNotNull("cursor", req.getCursor(), form);
         setIfNotNull("team_id", req.getTeamId(), form);
         return form;
     }

slack-api-client/src/main/java/com/slack/api/methods/request/reactions/ReactionsListRequest.java

@@ -32,6 +32,8 @@ public class ReactionsListRequest implements SlackApiRequest {
 
     private Integer limit;
 
+    private String cursor;
+
     /**
      * Required for org-wide apps.
      */

slack-api-client/src/main/java/com/slack/api/methods/response/reactions/ReactionsListResponse.java

@@ -20,7 +20,8 @@ public class ReactionsListResponse implements SlackApiTextResponse {
     private transient Map<String, List<String>> httpResponseHeaders;
 
     private List<Item> items;
-    private Paging paging;
+    private Paging paging; // for "count" and "page"
+    private ResponseMetadata responseMetadata; // only when "limit" parameter is given
 
     @Data
     public static class Item {

slack-api-client/src/test/java/test_with_remote_apis/methods/reactions_Test.java

@@ -196,4 +196,28 @@ public void list_async() throws ExecutionException, InterruptedException {
         assertThat(response.getItems(), is(notNullValue()));
     }
 
+    @Test
+    public void paginationWithLimitAndCursor() throws IOException, SlackApiException {
+        String user = slack.methods().usersList(r -> r.token(botToken))
+                .getMembers().get(0).getId();
+
+        ReactionsListResponse pageOne = slack.methods().reactionsList(r -> r
+                .token(botToken)
+                .user(user)
+                .limit(1)
+        );
+        assertThat(pageOne.getError(), is(nullValue()));
+        assertThat(pageOne.getResponseMetadata().getNextCursor(), is(notNullValue()));
+
+        ReactionsListResponse pageTwo = slack.methods().reactionsList(r -> r
+                .token(botToken)
+                .user(user)
+                .cursor(pageOne.getResponseMetadata().getNextCursor())
+                .limit(1)
+        );
+        assertThat(pageTwo.getError(), is(nullValue()));
+        assertThat(pageTwo.getResponseMetadata().getNextCursor(),
+                is(not(pageOne.getResponseMetadata().getNextCursor())));
+    }
+
 }