Message Read Receipt

/// Sample API call
V2TIMMessage *message = [[V2TIMManager sharedInstance] createTextMessage:@"Group message read receipt"];
// Specify that the message requires a read receipt
message.needReadReceipt = YES;
// Send the message
[[V2TIMManager sharedInstance] sendMessage:message receiver:nil groupID:@"groupA" priority:V2TIM_PRIORITY_NORMAL onlineUserOnly:NO offlinePushInfo:nil progress:nil succ:nil fail:nil];

class SendCallback final : public V2TIMSendCallback {
public:
    using SuccessCallback = std::function<void(const V2TIMMessage&)>;
    using ErrorCallback = std::function<void(int, const V2TIMString&)>;
    using ProgressCallback = std::function<void(uint32_t)>;

    SendCallback() = default;
    ~SendCallback() override = default;

    void SetCallback(SuccessCallback success_callback, ErrorCallback error_callback,
                     ProgressCallback progress_callback) {
        success_callback_ = std::move(success_callback);
        error_callback_ = std::move(error_callback);
        progress_callback_ = std::move(progress_callback);
    }

    void OnSuccess(const V2TIMMessage& message) override {
        if (success_callback_) {
            success_callback_(message);
        }
    }
    void OnError(int error_code, const V2TIMString& error_message) override {
        if (error_callback_) {
            error_callback_(error_code, error_message);
        }
    }
    void OnProgress(uint32_t progress) override {
        if (progress_callback_) {
            progress_callback_(progress);
        }
    }

private:
    SuccessCallback success_callback_;
    ErrorCallback error_callback_;
    ProgressCallback progress_callback_;
};

V2TIMMessage message = V2TIMManager::GetInstance()->GetMessageManager()->CreateTextMessage(u8"Group message read receipt");
// Specify that the message requires a read receipt
message.setNeedReadReceipt(true);

auto callback = new SendCallback{};
callback->SetCallback([=](const V2TIMMessage& message) { delete callback; },
                      [=](int error_code, const V2TIMString& error_message) { delete callback; },
                      [=](uint32_t progress) {});

V2TIMManager::GetInstance()->GetMessageManager()->SendMessage(
    message, "groupA", {}, V2TIMMessagePriority::V2TIM_PRIORITY_DEFAULT, false, {}, callback);

/// Sample API call
/// Suppose the user has read the `msg` message
if (!msg.isSelf && msg.needReadReceipt) {
    [[V2TIMManager sharedInstance] sendMessageReadReceipts:@[msg] succ:^{
        // Read receipt for the message sent successfully
    } fail:^(int code, NSString *desc) {
        // Failed to send a read receipt for the message
    }];
}

class Callback final : public V2TIMCallback {
public:
    using SuccessCallback = std::function<void()>;
    using ErrorCallback = std::function<void(int, const V2TIMString&)>;

    Callback() = default;
    ~Callback() override = default;

    void SetCallback(SuccessCallback success_callback, ErrorCallback error_callback) {
        success_callback_ = std::move(success_callback);
        error_callback_ = std::move(error_callback);
    }

    void OnSuccess() override {
        if (success_callback_) {
            success_callback_();
        }
    }
    void OnError(int error_code, const V2TIMString& error_message) override {
        if (error_callback_) {
            error_callback_(error_code, error_message);
        }
    }

private:
    SuccessCallback success_callback_;
    ErrorCallback error_callback_;
};

auto callback = new Callback;
callback->SetCallback(
    [=]() {
        // Read receipt for the message sent successfully
        delete callback;
    },
    [=](int error_code, const V2TIMString& error_message) {
        // Failed to send a read receipt for the message
        delete callback;
    });

// Suppose the user has read the `message` message
if (!message.isSelf && message.needReadReceipt) {
    V2TIMMessageVector messageList;
    messageList.PushBack(message);
    V2TIMManager::GetInstance()->GetMessageManager()->SendMessageReadReceipts(messageList, callback);
}

/// Sample API call
[[V2TIMManager sharedInstance] addAdvancedMsgListener:self];
- (void)onRecvMessageReadReceipts:(NSArray<V2TIMMessageReceipt *> *)receiptList {
    for(V2TIMMessageReceipt *receipt in receiptList) {
        // Message ID
        NSString *msgID = receipt.msgID;
        // ID of the other party of the one-to-one message
        NSString * userID = receipt.userID;
        // Read status of the other party of the one-to-one message
        BOOL isPeerRead = receipt.isPeerRead;
        // Group ID
        NSString * groupID = receipt.groupID;
        // Latest read count of the group message
        uint64_t readCount = receipt.readCount;
        // Latest unread count of the group message
        uint64_t unreadCount = receipt.unreadCount;
    }
}

class AdvancedMsgListener final : public V2TIMAdvancedMsgListener {
public:
    void OnRecvMessageReadReceipts(const V2TIMMessageReceiptVector& receiptList) override {
        for (size_t i = 0; i < receiptList.Size(); ++i) {
            const V2TIMMessageReceipt& receipt = receiptList[i];
            // Message ID
            V2TIMString msgID = receipt.msgID;
            // ID of the other party of the one-to-one message
            V2TIMString userID = receipt.userID;
            // Read status of the other party of the one-to-one message
            bool isPeerRead = receipt.isPeerRead;
            // Latest read count of the group message
            int32_t readCount = receipt.readCount;
            // Latest unread count of the group message
            int32_t unreadCount = receipt.unreadCount;
        }
    }
    // Other members ...
};

// Note that `advancedMsgListener` should not be released before the IM SDK is uninitialized,
// otherwise the message callback cannot be called.
AdvancedMsgListener advancedMsgListener;
V2TIMManager::GetInstance()->GetMessageManager()->AddAdvancedMsgListener(&advancedMsgListener);

/// Sample API call (taking a group message as an example)
[[V2TIMManager sharedInstance] getGroupHistoryMessageList:@"groupA" count:20 lastMsg:nil succ:^(NSArray<V2TIMMessage *> *msgs) {
    NSMutableArray *receiptMsgs = [NSMutableArray array];
    // If the message sent by you requires a read receipt, the message read receipt information will need to be pulled.
    for (V2TIMMessage *msg in msgs) {
        if (msg.isSelf && msg.needReadReceipt) {
            [receiptMsgs addObject:msg];
        }
    }
    [[V2TIMManager sharedInstance] getMessageReadReceipts:receiptMsgs succ:^(NSArray<V2TIMMessageReceipt *> *receiptList) {
       NSMutableDictionary *param = [NSMutableDictionary dictionary];
       for (V2TIMMessageReceipt *receipt in receiptList) {
           [param setObject:receipt forKey:receipt.msgID];
       }
       for (V2TIMMessage *msg in msgs) {
           V2TIMMessageReceipt *receipt = param[msg.msgID];
           // ID of the other party of the one-to-one message
           NSString * userID = receipt.userID;
           // Read status of the other party of the one-to-one message
           BOOL isPeerRead = receipt.isPeerRead;
           // Group ID
           NSString * groupID = receipt.groupID;
           // Message read count. If `readCount` is `0`, no one has read the message.
           uint64_t readCount = receipt.readCount;
           // Message unread count. If `unreadCount` is `0`, all members have read the message.
           uint64_t unreadCount = receipt.unreadCount;
       }
    } fail:^(int code, NSString *desc) {
       // Failed to pull the message read status
    }];
} fail:^(int code, NSString *desc) {
    // Failed to pull the message
}];

template <class T>
class ValueCallback final : public V2TIMValueCallback<T> {
public:
    using SuccessCallback = std::function<void(const T&)>;
    using ErrorCallback = std::function<void(int, const V2TIMString&)>;

    ValueCallback() = default;
    ~ValueCallback() override = default;

    void SetCallback(SuccessCallback success_callback, ErrorCallback error_callback) {
        success_callback_ = std::move(success_callback);
        error_callback_ = std::move(error_callback);
    }

    void OnSuccess(const T& value) override {
        if (success_callback_) {
            success_callback_(value);
        }
    }
    void OnError(int error_code, const V2TIMString& error_message) override {
        if (error_callback_) {
            error_callback_(error_code, error_message);
        }
    }

private:
    SuccessCallback success_callback_;
    ErrorCallback error_callback_;
};

// Sample API call (taking a group message as an example)
V2TIMMessageListGetOption option;
option.getType = V2TIMMessageGetType::V2TIM_GET_CLOUD_OLDER_MSG;
option.count = 20;
option.groupID = "groupA";

auto callback = new ValueCallback<V2TIMMessageVector>{};
callback->SetCallback(
    [=](const V2TIMMessageVector& messageList) {
        V2TIMMessageVector receiptMsgs;
        for (size_t i = 0; i < messageList.Size(); ++i) {
            const V2TIMMessage& message = messageList[0];
            // If the message sent by you requires a read receipt,
            // the message read receipt information will need to be pulled.
            if (message.isSelf && message.needReadReceipt) {
                receiptMsgs.PushBack(message);
            }
        }

        auto receipt_callback = new ValueCallback<V2TIMMessageReceiptVector>{};
        receipt_callback->SetCallback(
            [=](const V2TIMMessageReceiptVector& receiptList) {
                std::unordered_map<V2TIMString, V2TIMMessageReceipt> map;
                for (size_t i = 0; i < receiptList.Size(); ++i) {
                    const V2TIMMessageReceipt& receipt = receiptList[i];
                    map[receipt.msgID] = receipt;
                }
                for (size_t i = 0; i < messageList.Size(); ++i) {
                    const V2TIMMessage& message = messageList[0];
                    if (map.count(message.msgID)) {
                        const V2TIMMessageReceipt& receipt = map[message.msgID];
                        // ID of the other party of the one-to-one message
                        V2TIMString userID = receipt.userID;
                        // Read status of the other party of the one-to-one message
                        bool isPeerRead = receipt.isPeerRead;
                        // Group ID
                        V2TIMString groupID = receipt.groupID;
                        // Message read count. If `readCount` is `0`, no one has read the message.
                        int32_t readCount = receipt.readCount;
                        // Message unread count. If `unreadCount` is `0`, all members have read the message.
                        int32_t unreadCount = receipt.unreadCount;
                    }
                    const V2TIMMessageReceipt& receipt = receiptList[i];
                }

                delete receipt_callback;
            },
            [=](int error_code, const V2TIMString& error_message) {
                // Failed to pull the message read status
                delete receipt_callback;
            });

        V2TIMManager::GetInstance()->GetMessageManager()->GetMessageReadReceipts(messageList, receipt_callback);

        delete callback;
    },
    [=](int error_code, const V2TIMString& error_message) {
        // Failed to pull the message
        delete callback;
    });

V2TIMManager::GetInstance()->GetMessageManager()->GetHistoryMessageList(option, callback);