Callback listeners

Observing the message events Individually#

Use the event listeners for all the message related events, so that you can update the UI immediately based on the message events.Once you have sent the message via sdk, you will get the callbacks for message status events. This is common for both single chat and groups.

tip

There can be used as multiple message listener at a time, if you set multiple times using the below method it will not replace the old listener.

Event Listener for Incoming Message#

Mirrorfly.onMessageReceived.listen((event){
var chatMessageModel = sendMessageModelFromJson(event);
//called when the new message is received
});

Event Listener for Edit Message#

Mirrorfly.onMessageEdited.listen((event){
var chatMessageModel = sendMessageModelFromJson(event);
//called when the message is edited
});

Event Listener for Message Status Updates#

Mirrorfly.onMessageStatusUpdated.listen((event){
var chatMessageModel = sendMessageModelFromJson(event);
//called when the message status is updated
//find the index of message object in list using messageId
//then fetch message object from db using `Mirrorfly.getMessageOfId(messageId)` and notify the item in list
});

Event Listener for Media Message Status Updates#

Mirrorfly.onMediaStatusUpdated.listen((event){
var chatMessageModel = sendMessageModelFromJson(event);
//called when the media message status is updated like downloaded,uploaded,failed
//find the index of message object in list using messageId and notify the item in list
});

Event Listener for Media Message Upload/Download Progress Updates#

Mirrorfly.onUploadDownloadProgressChanged.listen((event){
var data = json.decode(event.toString());
var messageId = data["message_id"] ?? "";
var progressPercentage = data["progress_percentage"] ?? 0;
});

Event Listener for Message Notification's#

Mirrorfly.showOrUpdateOrCancelNotification.listen((event){
// This event is triggered when the user needs to be notified.
// You can display the notification in the UI if necessary.
var data = json.decode(event.toString());
var jid = data["jid"];
var chatMessage = sendMessageModelFromJson(data["chatMessage"]);
});

User came online#

If a user came online then the following method will be triggered.

Mirrorfly.userCameOnline.listen((event){
var data = json.decode(event.toString());
var jid = data["jid"];
//jid will be user's Jid who just came online
});

User went offine#

If a user went offline then the following method will be triggered.

Mirrorfly.userWentOffline.listen((event){
var data = json.decode(event.toString());
var jid = data["jid"];
//jid will be user's Jid who just went offline
});

User typing status#

To observe the typing status changes, you can use the below method to setup the listener.

Mirrorfly.typingStatus.listen((event) {
var data = json.decode(event.toString());
var singleOrgroupJid = data["singleOrgroupJid"];
var userJid = data["userJid"];
var typingStatus = data["status"];
});

Available Features status#

To observe the available features based on your subscription, you can use the below method to setup the listener.

Mirrorfly.onAvailableFeaturesUpdated.listen((value) {
var features = availableFeaturesFromJson(value.toString());
});

Observing the Archive Chats events#

When the Recent Chat Archive/UnArchive by user this callback will be triggered.

Mirrorfly.onArchiveUnArchiveChats.listen((event) {
});

Observing the Archive Settings#

When a user change on Archive Settings option this event will be triggered.

Mirrorfly.onArchivedSettingsUpdated.listen((archivedSettingsStatus) {
});

Observe Mute Settings Update#

Once mute settings are updated, the result is received via the following callback:

Mirrorfly.onUpdateMuteSettings.listen((event) {
var muteSettings = jsonDecode(response);
var isSuccess = muteSettings["isSuccess"];
var message = muteSettings["message"];
var isMuteStatus = muteSettings["isMuteStatus"];
});

Observe Chat Mute Settings Update#

Once mute settings are updated, the result is received via the following callback:

Mirrorfly.onChatMuteStatusUpdated.listen((response) {
var muteStatus = jsonDecode(response);
var isSuccess = muteStatus["isSuccess"];
var message = muteStatus["message"].toString();
var jidList = List<String>.from((muteStatus["jidList"] ?? "").map((x) => x.toString()));
var muteStatus = muteStatus["muteStatus"].toString();
});

Observe Message Delete Update#

when the message is deleted for me or deleted for everyone by the current user or end user.

Mirrorfly.onMessageDeleted.listen((response) {
var data = jsonDecode(response);
var toJid = data["toJid"].toString();
var messageIds = List<String>.from((data["messageIds"] ?? "").map((x) => x.toString()));
var messageDeleteType = data["messageDeleteType"].toString(); //deleteForMe or deleteForEveryone
});

Observe Chat Cleared#

when the chat is cleared or chat is deleted.

Mirrorfly.onChatCleared.listen((response) {
var data = jsonDecode(response);
var toJid = data["toJid"].toString();
var chatClearType = data["chatClearType"].toString(); // delete or clear
});

Observe All Chat Cleared#

when the all chat's Conversation are cleared.

Mirrorfly.onAllChatsCleared.listen((event) {
});
info

For group, message status will be updated only if all the participants sent the delivery/seen status.

Observing the message events Collectively#

Assign the listener to the appropriate class to receive event updates. Extend the class and implement the necessary event listeners collectively for streamlined integration you can register your own listener by using the below method. This is common for both single chat and groups.

tip

There can be only one message listener at a time, if you set multiple times using the below method it will replace the old listener always.

Mirrorfly.setMessageEventListener(YourClass());
class YourClass extends MessageEventListeners{
@override
void onAvailableFeaturesUpdated(AvailableFeatures availableFeatures) {
// TODO: implement onAvailableFeaturesUpdated
}
@override
void onMediaStatusUpdated(ChatMessageModel mediaMessage) {
// TODO: implement onMediaStatusUpdated
}
@override
void onMessageReceived(ChatMessageModel chatMessage) {
// TODO: implement onMessageReceived
}
@override
void onMessageEdited(ChatMessageModel chatMessage) {
// TODO: implement onMessageEdited
}
@override
void onMessageStatusUpdated(ChatMessageModel chatMessage) {
// TODO: implement onMessageStatusUpdated
}
@override
void onUploadDownloadProgressChanged(String messageId, int progressPercentage) {
// TODO: implement onUploadDownloadProgressChanged
}
@override
void setTypingStatus(String singleOrGroupJid, String userJid, String status) {
// TODO: implement setTypingStatus
}
@override
void showOrUpdateOrCancelNotification(String jid, ChatMessageModel chatMessageModel) {
// TODO: implement showOrUpdateOrCancelNotification
}
@override
void userCameOnline(String jid) {
// TODO: implement userCameOnline
}
@override
void userWentOffline(String jid) {
// TODO: implement userWentOffline
}
}

Observe QR Code Logged-in Session Logout Events#

When a QR code logged-in session is logged out, the following method will be triggered.

Mirrorfly.onWebLogout.listen((event) {
});