TIMGroupIncreaseGroupCounter
Introduction
Increase group counter
If the key of the counter exists, it will be incremented directly based on the current value based on the incoming group_counter_value; otherwise, add the key and increment it based on the incoming group_counter_value based on the default value of 0; - The group counter supports all group types except groups and topics.
Parameter details
| Parameter name | Parameter type | Required | Description |
|---|---|---|---|
| IncreaseGroupCounterParam | IncreaseGroupCounterParam | yes | IncreaseGroupCounterParam |
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:IncreaseGroupCounterParam ={
group_id: "@TGS#",
group_counter_key: "key",
group_counter_value: 3
}
timRenderInstance.TIMGroupIncreaseGroupCounter(param)