tencent cloud

Feedback

JavaScript

Last updated: 2024-11-13 18:11:10

    Feature Description

    A user's conversation list usually contains multiple conversations. If there is a new message in one of the conversations, a badge needs to be displayed in the list cell to indicate the unread count. After the user clicks to enter the conversation and goes back to the conversation list, the unread count is cleared, and the badge disappears. In some applications, the total unread count of all the conversations is calculated and displayed at the bottom tab of the conversation list.

    Get the total number of unread messages in all conversations

    Note:
    1. Only applicable to Work/Public/Community/Meeting group. AVChatRoom are not currently supported.
    2. The total number of unread messages will subtract the unread count of conversations set to Do Not Disturb.
    3. The total number of unread messages does not include the unread count of system conversations.
    4. Because this interface relies on the SDK to synchronize the conversation list from the cloud, the total number of unread messages obtained immediately after successful login may be 0. The access side can update the local total number of unread messages in combination with the TencentCloud.EVENT.TOTAL_UNREAD_MESSAGE_COUNT_UPDATED event.
    API
    chat.getTotalUnreadMessageCount();
    Returned value
    Number
    Sample
    // The total number of unread messages in one-to-one and group conversations
    let totalUnreadCount = chat.getTotalUnreadMessageCount();

    Notification of change in total number of unread messages in all conversations

    Sample
    let onTotalUnreadMessageCountUpdated = function(event) {
    console.log(event.data);
    };
    chat.on(TencentCloudChat.EVENT.TOTAL_UNREAD_MESSAGE_COUNT_UPDATED, onTotalUnreadMessageCountUpdated);

    Clearing the conversation unread count

    API
    chat.setMessageRead(options);
    Parameter
    The options parameter is of the Object type. It contains the following attribute values:
    Name
    Type
    Description
    conversationID
    String
    Conversation ID. Valid values:
    C2C${userID} (for a one-to-one chat)
    GROUP{groupID}(for a group chat)
    @TIM#SYSTEM (for a system notification conversation)
    GROUP${topicID} (for a topic)
    Returned value
    Promise
    Sample
    // Set all the unread messages in a conversation as read
    let promise = chat.setMessageRead({conversationID: 'C2Cexample'});
    promise.then(function(imResponse) {
    // Set the unread messages as read successfully.
    // The value of the `unreadCount` attribute of the conversation with the specified ID is set to `0`.
    }).catch(function(imError) {
    // Failed to set the unread messages as read
    console.warn('setMessageRead error:', imError);
    });

    Clearing the unread count of all conversations

    API
    chat.setAllMessageRead(options);
    Parameter
    The options parameter is of the Object type. It contains the following attribute values:
    Name
    Type
    Description
    scope
    String | undefined
    Set the scope of message processing. Valid values:
    TencentCloudChat.TYPES.READ_ALL_C2C_MSG: set the unread messages of all the one-to-one conversations as read
    TencentCloudChat.TYPES.READ_ALL_GROUP_MSG: set the unread messages of all the group conversations as read
    TencentCloudChat.TYPES.READ_ALL_MSG (default value): set the unread messages of all the one-to-one and group conversations as read
    Returned value
    Promise
    Sample
    // Set the unread messages of all the conversations as read
    // Same as `chat.setAllMessageRead({scope: TencentCloudChat.TYPES.READ_ALL_MSG})`
    let promise = chat.setAllMessageRead();
    promise.then(function(imResponse) {
    // Set the unread messages as read successfully.
    // The values of the `unreadCount` attribute of all the conversations are set to `0`.
    }).catch(function(imError) {
    // Failed to set the unread messages as read
    console.warn('setAllMessageRead error:', imError);
    });
    // Set the unread messages of all the one-to-one conversations as read
    let promise = chat.setAllMessageRead({scope: TencentCloudChat.TYPES.READ_ALL_C2C_MSG});
    promise.then(function(imResponse) {
    // Set the unread messages as read successfully.
    // The values of the `unreadCount` attribute of all the one-to-one conversations are set to `0`.
    }).catch(function(imError) {
    // Failed to set the unread messages as read
    console.warn('setAllMessageRead error:', imError);
    });
    // Set the unread messages of all the group conversations as read
    let promise = chat.setAllMessageRead({scope: TencentCloudChat.TYPES.READ_ALL_GROUP_MSG});
    promise.then(function(imResponse) {
    // Set the unread messages as read successfully.
    // The values of the `unreadCount` attribute of all the group conversations are set to `0`.
    }).catch(function(imError) {
    // Failed to set the unread messages as read
    console.warn('setAllMessageRead error:', imError);
    });

    Sending a message excluded from the conversation unread count

    In normal cases, both one-to-one messages and group messages that are sent will be included in the unread count. The unreadCount attribute of the Conversation object indicates the unread message count of a conversation. If you want to send messages that will not be included in the unread count, such as tips or control messages, you can refer to the following code sample.
    Sample
    chat.sendMessage(message, {
    messageControlInfo: {
    // `unreadCount` of the conversation is not updated (the message is stored on the roaming server).
    excludedFromUnreadCount: true,
    // `lastMessage` of the conversation is not updated (the message is stored on the roaming server).
    excludedFromLastMessage: true
    }
    });
    
    Contact Us

    Contact our sales team or business advisors to help your business.

    Technical Support

    Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

    7x24 Phone Support