TIMGroupInviteMember
Introduction
Invite to group
Permission description：
Private group can only invite members.
Public/Meeting group invites members need peer's consent.
AVChatRoom cannot invite members.
Parameter details
| Parameter name | Parameter type | Required | Description |
|---|---|---|---|
| inviteMemberParams | InviteMemberParams | yes | Param of inviting to group |
Returned template
Promise<commonResult<string>>
{
code: TIMResult | TIMErrCode;
desc?: string | undefined;
json_param?: string | undefined;
json_params?: string | 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 | string ｜ undefined | Return value of calling API |
| json_params | string ｜ 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();
import { InviteMemberParams } from "im_electron_sdk/dist/interfaces";
let grouId = ''
let identifier = ''
let param: InviteMemberParams = {
params: {
group_invite_member_param_group_id: grouId, // required
group_invite_member_param_identifier_array: [identifier], // required
group_invite_member_param_user_data: '', // optional
},
data: 'test data' // optional
}
const { code } = await timRenderInstance.TIMGroupInviteMember(param)
if (code == 0) {
// success
}