setGroupCounters
、increaseGroupCounter
、decreaseGroupCounter
接口合并计算,SDK 限制为单个登录用户最多 5 秒调用 20 次,超过限制后接口返回 2996 错误码。getGroupCounters
接口单独计算,SDK 限制为单个登录用户最多 5 秒 20 次调用,超过限制后接口返回 2996 错误码。chat.setGroupCounters(options);
options
为 Object
类型,包含的属性值如下:参数 | 类型 | 说明 |
groupID | String | 群组 ID |
counters | Object | 群计数器 key-value |
Promise
// 设置计数器 key1 和 key2 的值为 0let promise = chat.setGroupCounters({groupID: 'group1',counters: { key1: 0, key2: 0 }});promise.then(function(imResponse) { // 设置成功console.log(imResponse.data.counters); // 设置成功的群计数器}).catch(function(imError) { // 设置失败console.warn('setGroupCounters error:', imError); // 设置群计数器失败的相关信息});
chat.increaseGroupCounter(options);
options
为 Object
类型,包含的属性值如下:参数 | 类型 | 说明 |
groupID | String | 群组 ID |
key | String | 群计数器 key |
value | Number | 群计数器 key 的变化量 |
Promise
// 假设当前的计数器 key1 的值是 8,调用 increaseGroupCounter 接口传入的递增变化量 value 为 2 后// 最终 key1 的值变为 10。let promise = chat.increaseGroupCounter({groupID: 'group1',key: 'key1',value: 2,});promise.then(function(imResponse) { // 递增成功console.log(imResponse.data);const { groupID, key, value } = imResponse.data;}).catch(function(imError) { // 递增失败console.warn('increaseGroupCounter error:', imError);});
chat.decreaseGroupCounter(options);
options
为 Object
类型,包含的属性值如下:参数 | 类型 | 说明 |
groupID | String | 群组 ID |
key | String | 群计数器 key |
value | Number | 群计数器 key 的变化量 |
Promise
// 假设当前的计数器 key1 的值是 8.// 调用 decreaseGroupCounter 接口传入的递减变化量 value 为 2 后// 最终 key1 的值变为 6。let promise = chat.decreaseGroupCounter({groupID: 'group1',key: 'key1',value: 2});promise.then(function(imResponse) { // 递减成功console.log(imResponse.data);const { groupID, key, value } = imResponse.data;}).catch(function(imError) { // 设置失败console.warn('decreaseGroupCounter error:', imError);});
chat.getGroupCounter(options);
options
为 Object
类型,包含的属性值如下:参数 | 类型 | 说明 |
groupID | String | 群组 ID |
keyList | Array | undefined | 群计数器 key 列表 |
Promise
// 获取群计数器 key1 和 key2 的值let promise = chat.getGroupCounters({groupID: 'group1',keyList: ['key1', 'key2']});promise.then(function(imResponse) { // 获取成功console.log(imResponse.data.counters);}).catch(function(imError) {console.warn('getGroupCounters error:', imError); // 获取群计数器失败的相关信息});
// 获取某一个群组全部的计数器let promise = chat.getGroupCounters({groupID: 'group1'});promise.then(function(imResponse) { // 获取成功console.log(imResponse.data.counters);}).catch(function(imError) {console.warn('getGroupCounters error:', imError); // 获取群计数器失败的相关信息});
setGroupCounters
、increaseGroupCounter
、decreaseGroupCounter
接口修改群计数器时,会触发 TencentCloudChat.EVENT.GROUP_COUNTER_UPDATED
事件,并返回变化后的 value 值。let onGroupCounterUpdated = function(event) {const { groupID, key, value } = event.data;// groupID - 群组 ID// key - 群计数器 key// value - 群计数器 key 对应的 value};chat.on(TencentCloudChat
.EVENT.GROUP_COUNTER_UPDATED, onGroupCounterUpdated);
本页内容是否解决了您的问题?