tencent cloud

Feedback

Last updated: 2024-06-12 17:47:36

    Overview

    You can configure a specific number of counters for each group.Unlike custom group attributes, group counters are used to store data of the integer type. You can use group counters to store additional information related to a group, such as the cumulative number of viewers, the number of views, the number of times the host has been liked, and the number of gifts the audience has given to the host of an audio-video group.
    Note:
    1. Group counters support all types of groups, excluding topic-enabled community groups.
    2. The group counter feature is supported only by the Premium edition.
    Keep the following in mind for group counters:
    1. A single group supports up to 20 group counters, that is, up to 20 keys per group.
    2. For a single group counter, the key can contain up to 128 characters, and the value must be of the integer type (signed integer of up to 64 bits).
    3. The setGroupCounters, increaseGroupCounter, and decreaseGroupCounter APIs together can be called by a logged-in user up to 20 times every five seconds in the SDK, and the 2996 error code will be returned if the limit is exceeded.
    4. The getGroupCounters API can be called by a logged-in user up to 20 times every five seconds in the SDK, and the 2996 error code will be returned if the limit is exceeded.

    Display Effect

    

    Setting Group Counters

    You can call the setGroupCounters API to set multiple group counters. After group counters are set, the TencentCloudChat.EVENT.GROUP_COUNTER_UPDATED event will be triggered.
    Note:
    1. If key of the group counter to be set already exists, the value of key is updated directly. Otherwise, a key-value pair will be added.
    2. If multiple users set the same counter at the same time, the final value of the counter will be used. It's recommended that the group owner performs counter setting operations.
    API
    chat.setGroupCounters(options);
    Parameters
    The options parameter is of the Object type. It contains the following attribute values:
    Name
    Type
    Description
    groupID
    String
    Group ID.
    counters
    Object
    Group counter key-value pair.
    Return values
    Promise
    Sample
    // Set the values of counters `key1` and `key2` to 0.
    let promise = tim.setGroupCounters({
    groupID: 'group1',
    counters: { key1: 0, key2: 0 }
    });
    promise.then(function(imResponse) { // Set successfully.
    console.log(imResponse.data.counters); // Group attributes set successfully.
    }).catch(function(imError) { // Setting failed.
    console.warn('setGroupCounters error:', imError); // Error information.
    });

    Increasing the Value of a Group Counter

    You can call the increaseGroupCounter API to increase the value of a group counter. After the value of the group counter is increased, the TencentCloudChat.EVENT.GROUP_COUNTER_UPDATED event will be triggered.
    Note
    The API parameter value is the change value. Each time when the API is called, the current value of value is increased by the value passed in.
    If the key of the group counter to be set already exists, the current value of value is directly increased by the value passed in. Otherwise, a key will be added, and the default value (0) of value is increased by the value passed in.
    API
    chat.increaseGroupCounter(options);
    Parameters
    The options parameter is of the Object type. It contains the following attribute values:
    Name
    Type
    Description
    groupID
    String
    Group ID.
    key
    String
    Group counter key.
    value
    Number
    Increment value of the group counter key.
    Return values
    Promise
    Sample
    // Assume that the value of counter `key1` is 8.
    // After you call the `increaseGroupCounter` API to pass in an increment value of 2
    // the value of `key1` becomes 10.
    let promise = chat.increaseGroupCounter({
    groupID: 'group1',
    key: 'key1',
    value: 2,
    });
    promise.then(function(imResponse) { // Group counter increased successfully.
    console.log(imResponse.data);
    const { groupID, key, value } = imResponse.data;
    }).catch(function(imError) { // Failed to increase the group counter.
    console.warn('increaseGroupCounter error:', imError);
    });

    Decreasing the Value of a Group Counter

    You can call the decreaseGroupCounter API to decrease the value of a group counter. After the value of the group counter is decreased, the TencentCloudChat.EVENT.GROUP_COUNTER_UPDATED event will be triggered.
    Note
    1. The API parameter value is the change value. Each time when the API is called, the current value of value is decreased by the value passed in.
    2. If the key of the group counter to be set already exists, the current value of value is directly decreased by the value passed in. Otherwise, a key will be added, and the default value (0) of value is decreased by the value passed in.
    API
    chat.decreaseGroupCounter(options);
    Parameters
    The options parameter is of the Object type. It contains the following attribute values:
    Name
    Type
    Description
    groupID
    String
    Group ID.
    key
    String
    Group counter key.
    value
    Number
    Decrement value of the group counter key.
    Return values
    Promise
    Sample
    // Assume that the value of counter `key1` is 8.
    // After you call the `decreaseGroupCounter` API to pass in a decrement value of 2
    // the value of `key1` becomes 6.
    let promise = chat.decreaseGroupCounter({
    groupID: 'group1',
    key: 'key1',
    value: 2
    });
    promise.then(function(imResponse) { // Group counter decreased successfully.
    console.log(imResponse.data);
    const { groupID, key, value } = imResponse.data;
    }).catch(function(imError) { // Setting failed.
    console.warn('decreaseGroupCounter error:', imError);
    });

    Getting Group Counters

    You can call the getGroupCounters API to pass in a set of keys to get the information of the corresponding group counters. The API will return all key-value pairs matching the keys that are passed in.
    Note
    1. If you do not pass in the key list, all group counters are returned.
    API
    chat.getGroupCounter(options);
    Parameters
    The options parameter is of the Object type. It contains the following attribute values:
    Name
    Type
    Description
    groupID
    String
    Group ID.
    keyList
    Array | undefined
    List of group counter keys.
    Return values
    Promise
    Sample
    // Get the values of counters `key1` and `key2`.
    let promise = chat.getGroupCounters({
    groupID: 'group1',
    keyList: ['key1', 'key2']
    });
    promise.then(function(imResponse) { // Got successfully.
    console.log(imResponse.data.counters);
    }).catch(function(imError){
    console.warn('getGroupCounters error:', imError); // Error information.
    });
    // Get the values of all counters in a group.
    let promise = chat.getGroupCounters({
    groupID: 'group1'
    });
    promise.then(function(imResponse) { // Got successfully.
    console.log(imResponse.data.counters);
    }).catch(function(imError){
    console.warn('getGroupCounters error:', imError); // Error information.
    });

    Group Counter Change Notifications

    When you call the setGroupCounters, increaseGroupCounter, or decreaseGroupCounter API to modify group counters, the TencentCloudChat.EVENT.GROUP_COUNTER_UPDATED event will be triggered and the updated values will be returned.
    Note
    1. Before you can use the foregoing event, you need to call the on API to register for group counter change events.
    Sample
    let onGroupCounterUpdated = function(event) {
    const { groupID, key, value } = event.data;
    // groupID - Group ID.
    // key - Group counter key.
    // value - Value of the group counter key.
    };
    chat.on(TencentCloudChat.EVENT.GROUP_COUNTER_UPDATED, onGroupCounterUpdated);
    
    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