TIMGroupQuit
Introduction
Quit group
Permission description
For private group, all can quit the group.
For public/meeting group or AVChatRoom, group owner cannot quit.
Quit the specified group_id group, whether success or not you can tell from the callback.
Call GroupDelete to delete a group. Then all group members receive the GroupTipsEventCallback callback.
Parameter details
| Parameter name | Parameter type | Required | Description |
|---|---|---|---|
| quitGroupParams | QuitGroupParams | yes | Param of quitting 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 { QuitGroupParams } from "im_electron_sdk/dist/interfaces";
let groupId = ''
let param: QuitGroupParams = {
groupId: groupId, // required
data: '' // optional
}
const { code } = await timRenderInstance.TIMGroupQuit(param)
if (code == 0) {
// success
}