TIMGroupSetGroupCounters
Introduction
set group counters
If the key of the counter exists, update the value of the counter directly; if it does not exist, add the key-value of the counter;
When the group counter is set successfully, the finally successfully set group counter information will be returned in the callback cb;
The group counter supports all group types except groups and topics.
Parameter details
| Parameter name | Parameter type | Required | Description |
|---|---|---|---|
| GroupCounterParams | GroupCounterParams | yes | GroupCounterParams |
Returned template
Promise<commonResult<Array<GroupCounter> >>
{
code: TIMResult | TIMErrCode;
desc?: string | undefined;
json_param?: Array<GroupCounter> | undefined;
json_params?: Array<GroupCounter> | undefined;
user_data?: string | undefined;
}
Return value details
| name | type | description |
|---|---|---|
| code | TIMResult ｜ TIMErrCode | Request result: Error codes. 0 means success. |
| desc | string ｜ undefined | The description of the error. It will be empty if success. |
| json_param | Array< GroupCounter > ｜ undefined | Return value of calling API |
| json_params | Array< GroupCounter > ｜ undefined | Return value of calling API. Compatible field, which is returned in some cases. |
| user_data | string ｜ undefined | ImSDK is responsible for transporting user-defined data without any processing |
Code example
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)