TIMGroupGetPendencyList
功能介绍
获取群未决信息列表
此处的群未决消息泛指所有需要审批的群相关的操作。例如:加群待审批,拉人入群待审批等等。即便审核通过或者拒绝后,该条信息也可通过此接口拉回,拉回的信息中有已决标志。
UserA申请加入群GroupA,则群管理员可获取此未决相关信息,UserA因为没有审批权限,不需要获取此未决信息。
如果AdminA拉UserA进去GroupA,则UserA可以拉取此未决相关信息,因为该未决信息待UserA审批
权限说明:
只有审批人有权限拉取相关未决信息。
kTIMGroupPendencyOptionStartTime 设置拉取时间戳,第一次请求填0,后边根据server返回的 GroupPendencyResult键 kTIMGroupPendencyResultNextStartTime (参考下方)指定的时间戳进行填写。
kTIMGroupPendencyOptionMaxLimited 拉取的建议数量,server可根据需要返回或多或少,不能作为完成与否的标志
参数详解
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
getPendencyListParams | GetPendencyListParams | 是 | 获取群未决信息列表的参数 |
返回模板
Promise<commonResult<GroupPendencyResult>>
{
code: TIMResult | TIMErrCode;
desc?: string | undefined;
json_param?: GroupPendencyResult | undefined;
json_params?: GroupPendencyResult | undefined; // 兼容
user_data?: string | undefined;
}
返回值详解
名称 | 数值类型 | 描述 |
---|---|---|
code | TIMResult | TIMErrCode | 返回状态码 |
desc | string | undefined | 返回描述 |
json_param | GroupPendencyResult | undefined | 根据具具体接口返回 |
json_params | GroupPendencyResult | undefined | 兼容的字段,某些情况下会返回这个,根据具体接口返回 |
user_data | string | undefined | ImSDK负责透传的用户自定义数据,未做任何处理 |
代码示例
import TimRender from "im_electron_sdk/dist/renderer";
const timRenderInstance = new TimRender();
import { GetPendencyListParams } from "im_electron_sdk/dist/interfaces";
let param : GetPendencyListParams = {
params: {
group_pendency_option_start_time: 0, //必填
group_pendency_option_max_limited: 0, //必填
},
data: 'test data' //选填
}
const {code} =await timRenderInstance.TIMGroupGetPendencyList(param)
if(code == 0){
//获取成功
}