TIMGroupDecreaseGroupCounter

Introduction

Decrease group counter

If the key of the counter exists, the decrement operation will be performed directly on the basis of the current value according to the group_counter_value passed in; otherwise, the key will be added, and the decrement operation will be performed based on the group_counter_value passed in 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 Decrease group counter param

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 TIMResultTIMErrCode 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#172OQIUIO",
    group_counter_key: "key",
    group_counter_value: 3
}
timRenderInstance.TIMGroupDecreaseGroupCounter(param)

results matching ""

    No results matching ""