markAsDelivered()
method. This method takes the below parameters as input:
Parameter | Information |
---|---|
messageId | The ID of the message above which all the messages for a particular conversation are to be marked as read. |
receiverId | In case of one to one conversation message’s sender UID will be the receipt’s receiver Id. In case of group conversation message’s receiver Id will be the receipt’s receiver Id. |
receiverType | Type of the receiver. Could be either of the two values( user or group). |
senderId | The UID of the sender of the message. |
.then(successCallback, failureCallback)
of the markAsDelivered
method.
.then(successCallback, failureCallback)
of the markAsDelivered
method.
markAsRead()
method. This method takes the below parameters as input:
Parameter | Information |
---|---|
messageId | The ID of the message above which all the messages for a particular conversation are to be marked as read. |
receiverId | In case of one to one conversation message’s sender UID will be the receipt’s receiver Id. In case of group conversation message’s receiver Id will be the receipt’s receiver Id |
receiverType | Type of the receiver. Could be either of the two values( user or group) |
senderId | The UID of the sender of the message. |
.then(successCallback, failureCallback)
of the markAsDelivered
method.
.then(successCallback, failureCallback)
of the markAsDelivered
method.
markAsUnread()
method. This method takes the below parameters as input:
Parameter | Information |
---|---|
message | To mark a message as unread, pass a non-null BaseMessage instance to the markAsUnread() function. All messages below that message in the conversation will contribute to the unread messages count. Example: When User B sends User A a total of 10 messages, and User A invokes the markAsUnread() method on the fifth message, all messages located below the fifth message within the conversation list will be designated as unread. This results in a notification indicating there are 5 unread messages in the conversation list. |
listener | The callback listener that will be called on success or error. This should be a non-null CallbackListener instance. |
.then(successCallback, failureCallback).
onMessagesDelivered()
- This event is triggered when a message is delivered to a user.onMessagesRead()
- This event is triggered when a message is read by a user.onMessagesDeliveredToAll()
- This event is triggered when a group message is delivered to all members of the group. This event is only for Group conversations.onMessagesReadByAll()
- This event is triggered when a group message is read by all members of the group. This event is only for Group conversations.MessageReceipt
objects. The message receipt contains the below parameters:
Parameter | Information |
---|---|
messageId | The Id of the message prior to which all the messages for that particular conversation have been marked as read. |
sender | User object containing the details of the user who has marked the message as read. System User for deliveredToAll & readByAll events. |
receiverId | Id of the receiver whose conversation has been marked as read. |
receiverType | type of the receiver (user/group) |
receiptType | Type of the receipt (read/delivered) |
deliveredAt | The timestamp of the time when the message was delivered. This will only be present if the receiptType is delivered. |
readAt | The timestamp of the time when the message was read. This will only be present when the receiptType is read. |
deliveredAt
and readAt
which hold the timestamp for the time the message was delivered and read respectively. Using these two variables, the delivery and read status for a message can be obtained.
However, for a group message, if you wish to fetch the deliveredAt
and readAt
fields of individual member of the group you can use the below-described method.
getMessageReceipts()
method.
MessageReceipt
objects.
onMessagesDeliveredToAll
event,onMessagesReadByAll
event,deliveredAt
field in a group message,readAt
field in a group message.markAsUnread
method.