Skip to content

Commit 34a29c8

Browse files
refactor!: 🔨 update sendBy parameter name of Message class to sentBy (#188)
1 parent 232214c commit 34a29c8

13 files changed

+49
-45
lines changed

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@
66
json serializable of models and added copyWith method (Message, Reaction and Reply Message).
77
* **Breaking**: [181](https://github.com/SimformSolutionsPvtLtd/flutter_chatview/pull/181) Removed
88
deprecated field `showTypingIndicator` from ChatView.
9+
* **Breaking**: [187](https://github.com/SimformSolutionsPvtLtd/flutter_chatview/pull/187) update sendBy
10+
parameter name of Message class to sentBy
911
* **Feat**: [179](https://github.com/SimformSolutionsPvtLtd/flutter_chatview/pull/179) Added reply
1012
suggestions functionality
1113
* **Feat**: [157](https://github.com/SimformSolutionsPvtLtd/flutter_chatview/pull/157) Added onTap

README.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,8 @@ ChatView(
3434
),
3535
```
3636

37+
Renamed `sendBy` field to `sentBy` in `Message` class.
38+
3739
Updated `ChatUser`, `Message` and `ReplyMessage` Data Model's `fromJson` and `toJson` methods:
3840

3941
in `ChatUser.fromJson`:
@@ -222,13 +224,13 @@ List<Message> messageList = [
222224
id: '1',
223225
message: "Hi",
224226
createdAt: createdAt,
225-
sendBy: userId,
227+
sentBy: userId,
226228
),
227229
Message(
228230
id: '2',
229231
message: "Hello",
230232
createdAt: createdAt,
231-
sendBy: userId,
233+
sentBy: userId,
232234
),
233235
];
234236
```
@@ -240,7 +242,7 @@ void onSendTap(String message, ReplyMessage replyMessage, MessageType messageTyp
240242
id: '3',
241243
message: "How are you",
242244
createdAt: DateTime.now(),
243-
sendBy: currentUser.id,
245+
senBy: currentUser.id,
244246
replyMessage: replyMessage,
245247
messageType: messageType,
246248
);
@@ -389,10 +391,10 @@ ChatView(
389391
ChatView(
390392
...
391393
swipeToReplyConfig: SwipeToReplyConfiguration(
392-
onLeftSwipe: (message, sendBy){
394+
onLeftSwipe: (message, sentBy){
393395
// Your code goes here
394396
},
395-
onRightSwipe: (message, sendBy){
397+
onRightSwipe: (message, sentBy){
396398
// Your code goes here
397399
},
398400
),
@@ -658,7 +660,7 @@ ChatView(
658660
onReportTap: (Message message) {
659661
debugPrint('Message: $message');
660662
},
661-
onMoreTap: (Message message, bool sendByCurrentUser) {
663+
onMoreTap: (Message message, bool sentByCurrentUser) {
662664
debugPrint('Message : $message');
663665
},
664666
),

example/lib/data.dart

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,57 +8,57 @@ class Data {
88
id: '1',
99
message: "Hi!",
1010
createdAt: DateTime.now(),
11-
sendBy: '1', // userId of who sends the message
11+
sentBy: '1', // userId of who sends the message
1212
status: MessageStatus.read,
1313
),
1414
Message(
1515
id: '2',
1616
message: "Hi!",
1717
createdAt: DateTime.now(),
18-
sendBy: '2',
18+
sentBy: '2',
1919
status: MessageStatus.read,
2020
),
2121
Message(
2222
id: '3',
2323
message: "We can meet?I am free",
2424
createdAt: DateTime.now(),
25-
sendBy: '1',
25+
sentBy: '1',
2626
status: MessageStatus.read,
2727
),
2828
Message(
2929
id: '4',
3030
message: "Can you write the time and place of the meeting?",
3131
createdAt: DateTime.now(),
32-
sendBy: '1',
32+
sentBy: '1',
3333
status: MessageStatus.read,
3434
),
3535
Message(
3636
id: '5',
3737
message: "That's fine",
3838
createdAt: DateTime.now(),
39-
sendBy: '2',
39+
sentBy: '2',
4040
reaction: Reaction(reactions: ['\u{2764}'], reactedUserIds: ['1']),
4141
status: MessageStatus.read,
4242
),
4343
Message(
4444
id: '6',
4545
message: "When to go ?",
4646
createdAt: DateTime.now(),
47-
sendBy: '3',
47+
sentBy: '3',
4848
status: MessageStatus.read,
4949
),
5050
Message(
5151
id: '7',
5252
message: "I guess Simform will reply",
5353
createdAt: DateTime.now(),
54-
sendBy: '4',
54+
sentBy: '4',
5555
status: MessageStatus.read,
5656
),
5757
Message(
5858
id: '8',
5959
message: "https://bit.ly/3JHS2Wl",
6060
createdAt: DateTime.now(),
61-
sendBy: '2',
61+
sentBy: '2',
6262
reaction: Reaction(
6363
reactions: ['\u{2764}', '\u{1F44D}', '\u{1F44D}'],
6464
reactedUserIds: ['2', '3', '4'],
@@ -75,7 +75,7 @@ class Data {
7575
id: '9',
7676
message: "Done",
7777
createdAt: DateTime.now(),
78-
sendBy: '1',
78+
sentBy: '1',
7979
status: MessageStatus.read,
8080
reaction: Reaction(
8181
reactions: [
@@ -91,7 +91,7 @@ class Data {
9191
message: "Thank you!!",
9292
status: MessageStatus.read,
9393
createdAt: DateTime.now(),
94-
sendBy: '1',
94+
sentBy: '1',
9595
reaction: Reaction(
9696
reactions: ['\u{2764}', '\u{2764}', '\u{2764}', '\u{2764}'],
9797
reactedUserIds: ['2', '4', '3', '1'],
@@ -102,15 +102,15 @@ class Data {
102102
message: "https://miro.medium.com/max/1000/0*s7of7kWnf9fDg4XM.jpeg",
103103
createdAt: DateTime.now(),
104104
messageType: MessageType.image,
105-
sendBy: '1',
105+
sentBy: '1',
106106
reaction: Reaction(reactions: ['\u{2764}'], reactedUserIds: ['2']),
107107
status: MessageStatus.read,
108108
),
109109
Message(
110110
id: '12',
111111
message: "🤩🤩",
112112
createdAt: DateTime.now(),
113-
sendBy: '2',
113+
sentBy: '2',
114114
status: MessageStatus.read,
115115
),
116116
];

example/lib/main.dart

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ class _ChatScreenState extends State<ChatScreen> {
7777
id: DateTime.now().toString(),
7878
message: 'I will schedule the meeting.',
7979
createdAt: DateTime.now(),
80-
sendBy: '2',
80+
sentBy: '2',
8181
),
8282
);
8383
await Future.delayed(const Duration(milliseconds: 500));
@@ -321,7 +321,7 @@ class _ChatScreenState extends State<ChatScreen> {
321321
id: DateTime.now().toString(),
322322
createdAt: DateTime.now(),
323323
message: message,
324-
sendBy: currentUser.id,
324+
sentBy: currentUser.id,
325325
replyMessage: replyMessage,
326326
messageType: messageType,
327327
),

lib/src/controller/chat_controller.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ class ChatController {
124124
id: messageId,
125125
message: message.message,
126126
createdAt: message.createdAt,
127-
sendBy: message.sendBy,
127+
sentBy: message.sentBy,
128128
replyMessage: message.replyMessage,
129129
reaction: message.reaction,
130130
messageType: message.messageType,

lib/src/models/message.dart

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ class Message {
3737
final DateTime createdAt;
3838

3939
/// Provides id of sender of message.
40-
final String sendBy;
40+
final String sentBy;
4141

4242
/// Provides reply message if user triggers any reply on any message.
4343
final ReplyMessage replyMessage;
@@ -58,7 +58,7 @@ class Message {
5858
this.id = '',
5959
required this.message,
6060
required this.createdAt,
61-
required this.sendBy,
61+
required this.sentBy,
6262
this.replyMessage = const ReplyMessage(),
6363
Reaction? reaction,
6464
this.messageType = MessageType.text,
@@ -95,7 +95,7 @@ class Message {
9595
message: json['message']?.toString() ?? '',
9696
createdAt:
9797
DateTime.tryParse(json['createdAt'].toString()) ?? DateTime.now(),
98-
sendBy: json['sendBy']?.toString() ?? '',
98+
sentBy: json['sentBy']?.toString() ?? '',
9999
replyMessage: json['reply_message'] is Map<String, dynamic>
100100
? ReplyMessage.fromJson(json['reply_message'])
101101
: const ReplyMessage(),
@@ -116,7 +116,7 @@ class Message {
116116
'id': id,
117117
'message': message,
118118
'createdAt': createdAt.toIso8601String(),
119-
'sendBy': sendBy,
119+
'sentBy': sentBy,
120120
'reply_message': replyMessage.toJson(),
121121
'reaction': reaction.toJson(),
122122
'message_type': messageType.name,
@@ -129,7 +129,7 @@ class Message {
129129
GlobalKey? key,
130130
String? message,
131131
DateTime? createdAt,
132-
String? sendBy,
132+
String? sentBy,
133133
ReplyMessage? replyMessage,
134134
Reaction? reaction,
135135
MessageType? messageType,
@@ -141,7 +141,7 @@ class Message {
141141
id: id ?? this.message,
142142
message: message ?? this.message,
143143
createdAt: createdAt ?? this.createdAt,
144-
sendBy: sendBy ?? this.sendBy,
144+
sentBy: sentBy ?? this.sentBy,
145145
messageType: messageType ?? this.messageType,
146146
voiceMessageDuration: forceNullValue
147147
? voiceMessageDuration

lib/src/models/reply_popup_configuration.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ class ReplyPopupConfiguration {
2929
final Color? backgroundColor;
3030

3131
/// Provides builder for creating reply pop-up widget.
32-
final Widget Function(Message message, bool sendByCurrentUser)?
32+
final Widget Function(Message message, bool sentByCurrentUser)?
3333
replyPopupBuilder;
3434

3535
/// Provides callback on unSend button.

lib/src/models/swipe_to_reply_configuration.dart

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,10 +29,10 @@ class SwipeToReplyConfiguration {
2929
final Duration? animationDuration;
3030

3131
/// Provides callback when user swipe chat bubble from left side.
32-
final void Function(String message, String sendBy)? onLeftSwipe;
32+
final void Function(String message, String sentBy)? onLeftSwipe;
3333

3434
/// Provides callback when user swipe chat bubble from right side.
35-
final void Function(String message, String sendBy)? onRightSwipe;
35+
final void Function(String message, String sentBy)? onRightSwipe;
3636

3737
const SwipeToReplyConfiguration({
3838
this.replyIconColor,

lib/src/values/typedefs.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ typedef StringWithReturnWidget = Widget Function(String separator);
4242
typedef DragUpdateDetailsCallback = void Function(DragUpdateDetails);
4343
typedef MoreTapCallBack = void Function(
4444
Message message,
45-
bool sendByCurrentUser,
45+
bool sentByCurrentUser,
4646
);
4747
typedef ReactionCallback = void Function(
4848
Message message,

lib/src/widgets/chat_bubble_widget.dart

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ class ChatBubbleWidget extends StatefulWidget {
9999
class _ChatBubbleWidgetState extends State<ChatBubbleWidget> {
100100
String get replyMessage => widget.message.replyMessage.message;
101101

102-
bool get isMessageBySender => widget.message.sendBy == currentUser?.id;
102+
bool get isMessageBySender => widget.message.sentBy == currentUser?.id;
103103

104104
bool get isLastMessage =>
105105
chatController?.initialMessageList.last.id == widget.message.id;
@@ -124,7 +124,7 @@ class _ChatBubbleWidgetState extends State<ChatBubbleWidget> {
124124
@override
125125
Widget build(BuildContext context) {
126126
// Get user from id.
127-
final messagedUser = chatController?.getUserFromId(widget.message.sendBy);
127+
final messagedUser = chatController?.getUserFromId(widget.message.sentBy);
128128
return Stack(
129129
children: [
130130
if (featureActiveConfig?.enableSwipeToSeeTime ?? true) ...[
@@ -196,7 +196,7 @@ class _ChatBubbleWidgetState extends State<ChatBubbleWidget> {
196196
null) {
197197
widget.swipeToReplyConfig?.onLeftSwipe!(
198198
widget.message.message,
199-
widget.message.sendBy);
199+
widget.message.sentBy);
200200
}
201201
widget.onSwipe(widget.message);
202202
}
@@ -218,7 +218,7 @@ class _ChatBubbleWidgetState extends State<ChatBubbleWidget> {
218218
null) {
219219
widget.swipeToReplyConfig?.onRightSwipe!(
220220
widget.message.message,
221-
widget.message.sendBy);
221+
widget.message.sentBy);
222222
}
223223
widget.onSwipe(widget.message);
224224
}

0 commit comments

Comments
 (0)