TIMGroupInviteMember
功能介绍
邀请加入群组
工作群(Work):群里的任何人都可以邀请其他人进群。
会议群(Meeting)和公开群(Public):只有通过rest api 使用 App 管理员身份才可以邀请其他人进群。
直播群(AVChatRoom):不支持此功能。
参数详解
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
inviteMemberParams | InviteMemberParams | 是 | 邀请加入群组的参数 |
返回模板
Promise<commonResult<string>>
{
code: TIMResult | TIMErrCode;
desc?: string | undefined;
json_param?: string | undefined;
json_params?: string | undefined; // 兼容
user_data?: string | undefined;
}
返回值详解
名称 | 数值类型 | 描述 |
---|---|---|
code | TIMResult | TIMErrCode | 返回状态码 |
desc | string | undefined | 返回描述 |
json_param | string | undefined | 根据具具体接口返回 |
json_params | string | undefined | 兼容的字段,某些情况下会返回这个,根据具体接口返回 |
user_data | string | undefined | ImSDK负责透传的用户自定义数据,未做任何处理 |
代码示例
import TimRender from "im_electron_sdk/dist/renderer";
const timRenderInstance = new TimRender();
import { InviteMemberParams } from "im_electron_sdk/dist/interfaces";
let grouId = ''
let identifier = ''
let param : InviteMemberParams = {
params: {
group_invite_member_param_group_id: grouId, //必填
group_invite_member_param_identifier_array: [identifier], //必填
group_invite_member_param_user_data: '', //选填
},
data: 'test data' //选填
}
const {code} = await timRenderInstance.TIMGroupInviteMember(param)
if(code == 0){
//成功
}