added support for pagination params for listPushChannels

pubnub · Mar 27, 2024 · 9b2fbe8 · 9b2fbe8
1 parent 2a5f47e
commit 9b2fbe8
Show file tree

Hide file tree

Showing 3 changed files with 38 additions and 3 deletions.
diff --git a/pubnub/lib/src/dx/_endpoints/push.dart b/pubnub/lib/src/dx/_endpoints/push.dart
@@ -56,9 +56,11 @@ class ListPushChannelsParams extends Parameters {
   PushGateway pushGateway;
   Environment? environment;
   String? topic;
+  String? start;
+  int? count;
 
   ListPushChannelsParams(this.keyset, this.deviceId, this.pushGateway,
-      {this.topic, this.environment});
+      {this.topic, this.environment, this.start, this.count});
 
   @override
   Request toRequest() {
@@ -74,7 +76,9 @@ class ListPushChannelsParams extends Parameters {
     var queryParameters = {
       if (keyset.authKey != null) 'auth': '${keyset.authKey}',
       'uuid': '${keyset.uuid}',
-      'type': pushGateway.value()
+      'type': pushGateway.value(),
+      if (start != null && start!.isNotEmpty) 'start': start!,
+      if (count != null) 'count': '$count'
     };
     if (pushGateway == PushGateway.apns2) {
       queryParameters['environment'] =

diff --git a/pubnub/lib/src/dx/push/push.dart b/pubnub/lib/src/dx/push/push.dart
@@ -19,12 +19,16 @@ mixin PushNotificationDx on Core {
   /// If [gateway] is [PushGateway.apns2] then [topic] is mandatory to provide.
   /// [topic] is bundle id of the mobile application.
   /// [environment] denoting the environment of the mobile application for [PushGateway.apns2], it can be either:
+  /// [start] Starting channel for pagination. Use the last channel from the previous page request.
+  /// [count] Number of channels to return for pagination. Max of 1000 tokens at a time. Defaults to 500.
   /// * [Environment.development] (which is the default value).
   /// * [Environment.production].
   Future<ListPushChannelsResult> listPushChannels(
       String deviceId, PushGateway gateway,
       {String? topic,
       Environment? environment,
+      String? start,
+      int? count,
       Keyset? keyset,
       String? using}) async {
     keyset ??= keysets[using];
@@ -33,7 +37,7 @@ mixin PushNotificationDx on Core {
     if (gateway == PushGateway.apns2) Ensure(topic).isNotNull('topic');
 
     var params = ListPushChannelsParams(keyset, deviceId, gateway,
-        topic: topic, environment: environment);
+        topic: topic, environment: environment, start: start, count: count);
     return defaultFlow<ListPushChannelsParams, ListPushChannelsResult>(
         keyset: keyset,
         core: this,

diff --git a/pubnub/test/unit/dx/push_test.dart b/pubnub/test/unit/dx/push_test.dart
@@ -189,6 +189,33 @@ void main() {
               #environment: null
             }));
       });
+
+      test('listPushChannels delegate supported arguments', () async {
+        fakePubnub.returnWhen(
+            #listPushChannels,
+            Future.value(
+                ListPushChannelsResult.fromJson(['ch1', 'ch2', 'ch3'])));
+
+        await fakePubnub.listPushChannels('A332C23D', PushGateway.mpns,
+            start: 'ch2', count: 10);
+
+        var invocation = fakePubnub.invocations[0];
+
+        expect(invocation.isMethod, equals(true));
+        expect(invocation.memberName, equals(#listPushChannels));
+        expect(invocation.positionalArguments,
+            equals(['A332C23D', PushGateway.mpns]));
+        expect(
+            invocation.namedArguments,
+            equals({
+              #keyset: null,
+              #using: null,
+              #topic: null,
+              #environment: null,
+              #start: 'ch2',
+              #count: 10
+            }));
+      });
     });
   });
 }