On branch edburns/dd-2824425-fix-record-vs-getter-discrepancy

modified:   .github/copilot-instructions.md
modified:   README.md
modified:   src/site/markdown/advanced.md
modified:   src/site/markdown/cookbook/error-handling.md
modified:   src/site/markdown/cookbook/managing-local-files.md
modified:   src/site/markdown/cookbook/multiple-sessions.md
modified:   src/site/markdown/cookbook/persisting-sessions.md
modified:   src/site/markdown/cookbook/pr-visualization.md
modified:   src/site/markdown/documentation.md
modified:   src/site/markdown/getting-started.md
modified:   src/site/markdown/hooks.md
modified:   src/site/markdown/index.md
modified:   src/site/markdown/mcp.md

When the accessor style changed
Commit f5e9662 — February 10, 2026, authored by Bruno Borges.

"Refactor data access methods in tests to use new naming conventions"

Updated test assertions … to reflect changes in data access methods from getX() to x().

This was a massive breaking change across all 40+ event data types in com.github.copilot.sdk.events. Every public static class FooData with JavaBean getters/setters was converted to a public record FooData(...). This removed all getX() / setX() methods and replaced them with record component accessors (x()).

The commit was merged via PR #117 (feat/records-for-data-types) and shipped in v1.0.9 (the first release tag that contains it, alongside v1.0.10 and v1.0.11).

Timeline summary:

Before f5e9662: AssistantMessageData was a mutable static class with getContent(), setContent(), etc.
After f5e9662 (v1.0.9+): all event data types became Java records — content(), currentTokens(), tokenLimit(), messagesLength(), etc.
The README's Quick Start code was never updated to match — it still showed getContent() / getCurrentTokens() etc. until the fix applied in our current session.

Author: edburns

.github/copilot-instructions.md

@@ -124,7 +124,7 @@ session.createSession(new SessionConfig()
 Sessions emit typed events via `session.on()`:
 
 ```java
-session.on(AssistantMessageEvent.class, msg -> System.out.println(msg.getData().getContent()));
+session.on(AssistantMessageEvent.class, msg -> System.out.println(msg.getData().content()));
 session.on(SessionIdleEvent.class, idle -> done.complete(null));
 ```
 

README.md

@@ -63,16 +63,16 @@ public class CopilotSDK {
 
             // Handle assistant message events
             session.on(AssistantMessageEvent.class, msg -> {
-                System.out.println(msg.getData().getContent());
+                System.out.println(msg.getData().content());
             });
 
             // Handle session usage info events
             session.on(SessionUsageInfoEvent.class, usage -> {
                 var data = usage.getData();
                 System.out.println("\n--- Usage Metrics ---");
-                System.out.println("Current tokens: " + (int) data.getCurrentTokens());
-                System.out.println("Token limit: " + (int) data.getTokenLimit());
-                System.out.println("Messages count: " + (int) data.getMessagesLength());
+                System.out.println("Current tokens: " + (int) data.currentTokens());
+                System.out.println("Token limit: " + (int) data.tokenLimit());
+                System.out.println("Messages count: " + (int) data.messagesLength());
             });
 
             // Send a message

src/site/markdown/advanced.md

@@ -340,7 +340,7 @@ session.on(SessionCompactionStartEvent.class, start -> {
 session.on(SessionCompactionCompleteEvent.class, complete -> {
     var data = complete.getData();
     System.out.println("Compaction completed - success: " + data.isSuccess() 
-        + ", tokens removed: " + data.getTokensRemoved());
+        + ", tokens removed: " + data.tokensRemoved());
 });
 ```
 
@@ -856,7 +856,7 @@ session.on(AssistantMessageEvent.class, msg -> {
 
 session.on(AssistantMessageEvent.class, msg -> {
     // This handler executes normally despite the exception above
-    System.out.println(msg.getData().getContent());
+    System.out.println(msg.getData().content());
 });
 ```
 

src/site/markdown/cookbook/error-handling.md

@@ -44,7 +44,7 @@ public class BasicErrorHandling {
                 new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL).setModel("gpt-5")).get();
 
             session.on(AssistantMessageEvent.class, msg -> {
-                System.out.println(msg.getData().getContent());
+                System.out.println(msg.getData().content());
             });
 
             session.sendAndWait(new MessageOptions()
@@ -110,7 +110,7 @@ public class TimeoutHandling {
     public static void sendWithTimeout(CopilotSession session) {
         try {
             session.on(AssistantMessageEvent.class, msg -> {
-                System.out.println(msg.getData().getContent());
+                System.out.println(msg.getData().content());
             });
 
             // Wait up to 30 seconds for response
@@ -209,7 +209,7 @@ public class TryWithResources {
                     new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL).setModel("gpt-5")).get()) {
 
                 session.on(AssistantMessageEvent.class, msg -> {
-                    System.out.println(msg.getData().getContent());
+                    System.out.println(msg.getData().content());
                 });
 
                 session.sendAndWait(new MessageOptions()
@@ -254,7 +254,7 @@ public class ToolErrorHandling {
                 new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL).setTools(List.of(errorTool))).get();
 
             session.on(AssistantMessageEvent.class, msg -> {
-                System.out.println(msg.getData().getContent());
+                System.out.println(msg.getData().content());
             });
 
             // Session continues even when tool fails

src/site/markdown/cookbook/managing-local-files.md

@@ -54,15 +54,15 @@ public class ManagingLocalFiles {
             var done = new CountDownLatch(1);
 
             session.on(AssistantMessageEvent.class, msg -> 
-                System.out.println("\nCopilot: " + msg.getData().getContent())
+                System.out.println("\nCopilot: " + msg.getData().content())
             );
 
             session.on(ToolExecutionStartEvent.class, evt -> 
-                System.out.println("  → Running: " + evt.getData().getToolName())
+                System.out.println("  → Running: " + evt.getData().toolName())
             );
 
             session.on(ToolExecutionCompleteEvent.class, evt -> 
-                System.out.println("  ✓ Completed: " + evt.getData().getToolCallId())
+                System.out.println("  ✓ Completed: " + evt.getData().toolCallId())
             );
 
             session.on(SessionIdleEvent.class, evt -> done.countDown());
@@ -171,7 +171,7 @@ public class InteractiveFileOrganizer {
                 new SessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL).setModel("gpt-5")).get();
 
             session.on(AssistantMessageEvent.class, msg -> 
-                System.out.println("\nCopilot: " + msg.getData().getContent())
+                System.out.println("\nCopilot: " + msg.getData().content())
             );
 
             System.out.print("Enter folder path to organize: ");

src/site/markdown/cookbook/multiple-sessions.md

@@ -50,11 +50,11 @@ public class MultipleSessions {
 
             // Set up event handlers for each session
             session1.on(AssistantMessageEvent.class, msg -> 
-                System.out.println("Session 1: " + msg.getData().getContent()));
+                System.out.println("Session 1: " + msg.getData().content()));
             session2.on(AssistantMessageEvent.class, msg -> 
-                System.out.println("Session 2: " + msg.getData().getContent()));
+                System.out.println("Session 2: " + msg.getData().content()));
             session3.on(AssistantMessageEvent.class, msg -> 
-                System.out.println("Session 3: " + msg.getData().getContent()));
+                System.out.println("Session 3: " + msg.getData().content()));
 
             // Each session maintains its own conversation history
             session1.send(new MessageOptions()

src/site/markdown/cookbook/persisting-sessions.md

@@ -48,7 +48,7 @@ public class PersistingSessions {
             ).get();
 
             session.on(AssistantMessageEvent.class, msg -> 
-                System.out.println(msg.getData().getContent())
+                System.out.println(msg.getData().content())
             );
 
             session.sendAndWait(new MessageOptions()
@@ -76,7 +76,7 @@ public class ResumeSession {
             var session = client.resumeSession("user-123-conversation", new ResumeSessionConfig().setOnPermissionRequest(PermissionHandler.APPROVE_ALL)).get();
 
             session.on(AssistantMessageEvent.class, msg -> 
-                System.out.println(msg.getData().getContent())
+                System.out.println(msg.getData().content())
             );
 
             // Previous context is restored
@@ -141,7 +141,7 @@ public class SessionHistory {
             for (var event : messages) {
                 // Print different event types appropriately
                 if (event instanceof AssistantMessageEvent msg) {
-                    System.out.printf("[assistant] %s%n", msg.getData().getContent());
+                    System.out.printf("[assistant] %s%n", msg.getData().content());
                 } else if (event instanceof UserMessageEvent userMsg) {
                     System.out.printf("[user] %s%n", userMsg.getData().content());
                 } else {
@@ -218,7 +218,7 @@ public class SessionManager {
 
             if (session != null) {
                 session.on(AssistantMessageEvent.class, msg -> 
-                    System.out.println("\nCopilot: " + msg.getData().getContent())
+                    System.out.println("\nCopilot: " + msg.getData().content())
                 );
 
                 // Interactive conversation loop

src/site/markdown/cookbook/pr-visualization.md

@@ -101,11 +101,11 @@ public class PRVisualization {
 
             // Set up event handling
             session.on(AssistantMessageEvent.class, msg -> 
-                System.out.println("\n🤖 " + msg.getData().getContent() + "\n")
+                System.out.println("\n🤖 " + msg.getData().content() + "\n")
             );
 
             session.on(ToolExecutionStartEvent.class, evt -> 
-                System.out.println("  ⚙️  " + evt.getData().getToolName())
+                System.out.println("  ⚙️  " + evt.getData().toolName())
             );
 
             // Initial prompt - let Copilot figure out the details

src/site/markdown/documentation.md

@@ -40,7 +40,7 @@ try (var client = new CopilotClient()) {
     ).get();
 
     var response = session.sendAndWait("Explain Java records in one sentence").get();
-    System.out.println(response.getData().getContent());
+    System.out.println(response.getData().content());
 
     session.close();
 }
@@ -58,7 +58,7 @@ For straightforward interactions, use `sendAndWait()`:
 
 ```java
 var response = session.sendAndWait("What is the capital of France?").get();
-System.out.println(response.getData().getContent());
+System.out.println(response.getData().content());
 ```
 
 ### Event-Based Processing
@@ -103,7 +103,7 @@ var done = new CompletableFuture<Void>();
 
 // Type-safe event handlers (recommended)
 session.on(AssistantMessageEvent.class, msg -> {
-    System.out.println("Response: " + msg.getData().getContent());
+    System.out.println("Response: " + msg.getData().content());
 });
 
 session.on(SessionErrorEvent.class, err -> {
@@ -124,7 +124,7 @@ You can also use a single handler for all events:
 session.on(event -> {
     switch (event) {
         case AssistantMessageEvent msg -> 
-            System.out.println("Response: " + msg.getData().getContent());
+            System.out.println("Response: " + msg.getData().content());
         case SessionErrorEvent err -> 
             System.err.println("Error: " + err.getData().message());
         case SessionIdleEvent idle -> 
@@ -299,11 +299,11 @@ var history = session.getMessages().get();
 for (var event : history) {
     switch (event) {
         case UserMessageEvent user -> 
-            System.out.println("User: " + user.getData().getContent());
+            System.out.println("User: " + user.getData().content());
         case AssistantMessageEvent assistant -> 
-            System.out.println("Assistant: " + assistant.getData().getContent());
+            System.out.println("Assistant: " + assistant.getData().content());
         case ToolExecutionCompleteEvent tool -> 
-            System.out.println("Tool: " + tool.getData().getToolName());
+            System.out.println("Tool: " + tool.getData().toolName());
         default -> { }
     }
 }
@@ -596,8 +596,8 @@ var session2 = client.createSession(
 var future1 = session1.sendAndWait("Summarize REST APIs");
 var future2 = session2.sendAndWait("Summarize GraphQL");
 
-System.out.println("GPT: " + future1.get().getData().getContent());
-System.out.println("Claude: " + future2.get().getData().getContent());
+System.out.println("GPT: " + future1.get().getData().content());
+System.out.println("Claude: " + future2.get().getData().content());
 ```
 
 ### Resume a Previous Session

src/site/markdown/getting-started.md

@@ -81,7 +81,7 @@ public class HelloCopilot {
                 new MessageOptions().setPrompt("What is 2 + 2?")
             ).get();
 
-            System.out.println(response.getData().getContent());
+            System.out.println(response.getData().content());
         }
     }
 }