TIMGroupSetGroupCounters

功能介绍

设置群计数器

该计数器的 key 如果存在,则直接更新计数器的 value 值;如果不存在,则添加该计数器的 key-value;

当群计数器设置成功后,在回调 cb 中会返回最终成功设置的群计数器信息;

除了社群和话题,群计数器支持所有的群组类型。

参数详解

参数名称 参数类型 是否必填 描述
GroupCounterParams GroupCounterParams 群计数器的参数

返回模板

Promise<commonResult<Array<GroupCounter> >>

{
    code: TIMResult | TIMErrCode;
    desc?: string | undefined;
    json_param?: Array<GroupCounter> | undefined;
    json_params?: Array<GroupCounter> | undefined; // 兼容
    user_data?: string | undefined;
}

返回值详解

名称 数值类型 描述
code TIMResultTIMErrCode 返回状态码
desc string | undefined 返回描述
json_param Array< GroupCounter > | undefined 根据具具体接口返回
json_params Array< GroupCounter > | undefined 兼容的字段,某些情况下会返回这个,根据具体接口返回
user_data string | undefined ImSDK负责透传的用户自定义数据,未做任何处理

代码示例

import TimRender from "im_electron_sdk/dist/renderer";
const timRenderInstance = new TimRender();

let param:GroupCounterParams = {
    params:{
      group_id:"@TGS#",
      json_group_counter_array:[{
        group_counter_key:"key",
        group_counter_value:2
      }]
    }
}
timRenderInstance.TIMGroupSetGroupCounters(param)

results matching ""

    No results matching ""