Skip to content

Free, Open Source, Self-Hosted WhatsApp API Gateway

docs(sdk-java): describe what MessageRecord chatName and author hold

Yudhi Armyndharisabfa9fdc576f
diff --git a/sdk/java/src/main/java/com/rmyndharis/openwa/model/MessageRecord.java b/sdk/java/src/main/java/com/rmyndharis/openwa/model/MessageRecord.java
index b6e96357c..37ab9333e 100644
--- a/sdk/java/src/main/java/com/rmyndharis/openwa/model/MessageRecord.java
+++ b/sdk/java/src/main/java/com/rmyndharis/openwa/model/MessageRecord.java
@@ -17,9 +17,15 @@ public record MessageRecord(
String body,
String type,
MessageDirection direction,
- /** Chat display name, when the session resolves one for the chat. */
+ /**
+ * Push name of the sender as the engine reported it; in a group this is the member who posted,
+ * not the group subject. Null when no contact name was known.
+ */
String chatName,
- /** Author display name for an inbound group message. */
+ /**
+ * JID of the sender of a group, status or broadcast-list message ({@code from} is the group,
+ * {@code status@broadcast} or the list id there); null on 1:1 messages and outgoing echoes.
+ */
String author,
/** Storage key of the archived media copy, when chat-media archiving wrote one. */
String mediaPath,