decreaseGroupCounter
功能介绍
递减群计数器
与 群自定义属性不同 ,群计数器主要用来存储整数类型的数据,您可以使用群计数器来存储一些群相关的附加信息,例如直播群的累计观看人数、观看人次、主播被点赞的次数、观众累计送给主播的礼物数等。
除了话题外,群计数器支持所有的群类型;
群计数器功能仅旗舰版本支持。
setGroupCounters、increaseGroupCounter、decreaseGroupCounter 接口合并计算,SDK 限制为单个登录用户最多 5 秒调用 20 次,超过限制后接口回调 8516 错误码;
接口参数中的 value 为递减的变化量,调用接口后会在当前值的基础上减去传入的变化量;
如果您即将设置的计数器的 key 存在,则直接在当前值的基础上根据传入的 value 作递减操作;反之,添加 key,并在默认值为 0 的基础上根据传入的 value 作递减操作。
需要sdk版本大于或等于1.0.25
参数详解
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
groupID | string | 是 | 群组ID. |
key | string | 是 | 群计数器的 key. |
value | number | 是 | 群计数器的递减的变化量,计数器 key 对应的 value 变更方式为: new_value = old_value - value. |
返回模板
V2TimValueCallback<Map<String, number>>
{
code : number
desc : string
data : Map<String, number>
}
返回值详解
名称 | 数值类型 | 描述 |
---|---|---|
code | number | 请求结果错误码 |
desc | string | 请求结果描述符 |
data | Map |
修改后的计数器结果 |
代码示例
import { TencentImSDKPlugin } from 'react-native-tim-js';
const DecreaseGroupCounterresponse = await TencentImSDKPlugin.v2TIMManager
.getGroupManager()
.decreaseGroupCounter(
groupID,// 群组id
key,// 计数器key
parseInt(value, 10)// 递减数
);
if (DecreaseGroupCounterresponse.code === 0) {
// 递减成功
DecreaseGroupCounterresponse.data; // 递减后的计数器
}