一、功能描述
注意:说明:
关于群计数器,需要注意的是:
1. 单个群内最大支持 20 组群计数器,也即单个群内 key 的个数不超过 20 个;
2. 单个群计数器的 key 不超过 128 个字节,value 必须为整数类型(最大支持 64 位有符号整型);
3. GroupSetGroupCounters、GroupIncreaseGroupCounter、GroupDecreaseGroupCounter 接口合并计算,SDK 限制为单个登录用户最多 5 秒调用 20 次,超过限制后接口回调 8516 错误码;
4. GroupGetGroupCounters 接口单独计算,SDK 限制为单个登录用户最多 5 秒 20 次调用,超过限制后接口回调 8516 错误码。
二、设置群计数器
你可以调用接口 GroupSetGroupCounters(点击查看详情)设置多组群计数器。计数器设置成功后会触发 GroupCounterChangedCallback (点击查看详情)回调, GroupCounterChangedCallback 的使用参见下文的 群计数器变更通知。
注意:说明:
示例:调用 GroupSetGroupCounters 接口分别设置计数器 key1 和 key2 的值为 0。
//设置群计数器 List<GroupCounter> list = new List<GroupCounter> { new GroupCounter { group_counter_key = "key", group_counter_value = 1 } }; TIMResult res = TencentIMSDK.GroupSetGroupCounters("groupID", list, (int code, string desc, List<GroupCounter> results, string user_data)=>{ // 设置群计数器异步结果 });
三、递增群计数器
你可以调用递增接口 GroupIncreaseGroupCounter (点击查看详情) 对群计数器作累加操作,操作成功后会触发 GroupCounterChangedCallback (点击查看详情)回调。 GroupCounterChangedCallback 的使用参见下文的 群计数器变更通知。
注意:说明:
示例:假设当前的计数器 key1 的值是 8,调用 GroupIncreaseGroupCounter 接口传入的递增变化量 value 为 2 后,最终 key1 的值变为 10。
//递增群计数器 TIMResult res = TencentIMSDK.GroupIncreaseGroupCounter("groupID", "key1", 2, (int code, string desc, List<GroupCounter> results, string user_data)=>{ // 递增群计数器异步结果 });
四、递减群计数器
你可以调用递减接口 GroupDecreaseGroupCounter (点击查看详情) 对群计数器作累减操作,操作成功后会触发 GroupCounterChangedCallback (点击查看详情)回调, GroupCounterChangedCallback 的使用参见下文的 群计数器变更通知。
注意:说明:
示例:假设当前的计数器 key1 的值是 8,调用 GroupDecreaseGroupCounter 接口传入的递减变化量 value 为 2 后,最终 key1 的值变为 6。
//递减群计数器 TIMResult res = TencentIMSDK.GroupDecreaseGroupCounter("groupID", "key1", 2, (int code, string desc, List<GroupCounter> results, string user_data)=>{ // 递减群计数器异步结果 });
五、获取群计数器
你可以调用接口 GroupGetGroupCounters (点击查看详情) ,并通过传入一组指定的 key 来获取对应的群计数器信息。接口会返回所有的与 key 相匹配的 key-value 键值对。
注意:说明:
注意:如果传入的 key 列表为空,则返回所有的群计数器。
示例:调用接口 GroupGetGroupCounters 分别获取计数器 key1 和 key2 的值。
//获取群计数器 TIMResult res = TencentIMSDK.GroupGetGroupCounters("groupID", new List<string> {"key1", "key2"}, (int code, string desc, List<GroupCounter> results, string user_data)=>{ // 获取群计数器异步结果 });
六、群计数器变更通知
当你调用 GroupSetGroupCounters、GroupIncreaseGroupCounter、GroupDecreaseGroupCounter 接口修改群计数器时,会触发 GroupCounterChangedCallback 回调,并返回变化后的 value 值。
注意:说明:
注意:在使用上述回调之前,你需要调用接口 SetGroupCounterChangedCallback (点击查看详情)添加群监听器。
示例代码如下:
// 设置群计数器变更回调 TencentIMSDK.SetGroupCounterChangedCallback((string group_id, string group_counter_key, ulong group_counter_new_value, string user_data) => { });