Renamed leaderboardId parameter

heroiclabs · Feb 18, 2023 · 30122e2 · 30122e2
1 parent 325e5a8
commit 30122e2
Show file tree

Hide file tree

Showing 6 changed files with 13 additions and 12 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,7 @@
 ## unreleased
 
 * **Breaking:** Renamed `ChannelJoinType` enum to `ChannelType`
+* **Breaking:** Renamed `leaderboardId` parameter to `leaderboardName` in `writeLeaderboardRecord` and `deleteLeaderboardRecord`
 * Added `onPartyData` stream to realtime client
 
 ## 1.0.0-dev.3

diff --git a/lib/src/nakama_client/nakama_api_client.dart b/lib/src/nakama_client/nakama_api_client.dart
@@ -910,15 +910,15 @@ class NakamaRestApiClient extends NakamaBaseClient {
   @override
   Future<model.LeaderboardRecord> writeLeaderboardRecord({
     required model.Session session,
-    required String leaderboardId,
+    required String leaderboardName,
     int? score,
     int? subscore,
     String? metadata,
   }) async {
     _session = session;
 
     final res = await _api.v2LeaderboardLeaderboardIdPost(
-        leaderboardId: leaderboardId,
+        leaderboardId: leaderboardName,
         body: WriteLeaderboardRecordRequestLeaderboardRecordWrite(
           score: score?.toString(),
           subscore: subscore?.toString(),
@@ -931,11 +931,11 @@ class NakamaRestApiClient extends NakamaBaseClient {
   @override
   Future<void> deleteLeaderboardRecord({
     required model.Session session,
-    required String leaderboardId,
+    required String leaderboardName,
   }) async {
     _session = session;
 
-    await _api.v2LeaderboardLeaderboardIdDelete(leaderboardId: leaderboardId);
+    await _api.v2LeaderboardLeaderboardIdDelete(leaderboardId: leaderboardName);
   }
 
   @override

diff --git a/lib/src/nakama_client/nakama_client.dart b/lib/src/nakama_client/nakama_client.dart
@@ -379,7 +379,7 @@ abstract class NakamaBaseClient {
   /// for ordering when the scores are the same.
   Future<model.LeaderboardRecord> writeLeaderboardRecord({
     required model.Session session,
-    required String leaderboardId,
+    required String leaderboardName,
     int? score,
     int? subscore,
     String? metadata,
@@ -388,7 +388,7 @@ abstract class NakamaBaseClient {
   /// # Deleting records
   Future<void> deleteLeaderboardRecord({
     required model.Session session,
-    required String leaderboardId,
+    required String leaderboardName,
   });
 
   /// # Adding friends

diff --git a/lib/src/nakama_client/nakama_grpc_client.dart b/lib/src/nakama_client/nakama_grpc_client.dart
@@ -871,14 +871,14 @@ class NakamaGrpcClient extends NakamaBaseClient {
   @override
   Future<model.LeaderboardRecord> writeLeaderboardRecord({
     required model.Session session,
-    required String leaderboardId,
+    required String leaderboardName,
     int? score,
     int? subscore,
     String? metadata,
   }) async {
     final res = await _client.writeLeaderboardRecord(
       api.WriteLeaderboardRecordRequest(
-        leaderboardId: leaderboardId,
+        leaderboardId: leaderboardName,
         record: api.WriteLeaderboardRecordRequest_LeaderboardRecordWrite(
           score: score == null ? null : Int64(score),
           subscore: subscore == null ? null : Int64(subscore),
@@ -894,10 +894,10 @@ class NakamaGrpcClient extends NakamaBaseClient {
   @override
   Future<void> deleteLeaderboardRecord({
     required model.Session session,
-    required String leaderboardId,
+    required String leaderboardName,
   }) async {
     await _client.deleteLeaderboardRecord(api.DeleteLeaderboardRecordRequest(
-      leaderboardId: leaderboardId,
+      leaderboardId: leaderboardName,
     ));
   }
 

diff --git a/test/grpc/leaderboard_test.dart b/test/grpc/leaderboard_test.dart
@@ -31,7 +31,7 @@ void main() {
 
     test('write leaderboard record', () async {
       final result = await client.writeLeaderboardRecord(
-          session: session, leaderboardId: 'test', score: 10);
+          session: session, leaderboardName: 'test', score: 10);
 
       expect(result, isA<LeaderboardRecord>());
       expect(result.score, isNotNull);

diff --git a/test/rest/leaderboard_test.dart b/test/rest/leaderboard_test.dart
@@ -30,7 +30,7 @@ void main() {
 
     test('write leaderboard record', () async {
       final result = await client.writeLeaderboardRecord(
-          session: session, leaderboardId: 'test', score: 10);
+          session: session, leaderboardName: 'test', score: 10);
 
       expect(result, isA<LeaderboardRecord>());
       expect(result.score, isNotNull);