TIMGroupJoin
Introduction
Join group
Permission description
Private group doesn't allow user joining.
User can apply to joining Public group and ChatRoom.
If admission needs checking, wait for admin or group owner to grant admission, otherwise user joins to the group successfully by only calling this API.
Join group by specified group_id, and you can tell success or not from the callback.
Parameter details
| Parameter name | Parameter type | Required | Description |
|---|---|---|---|
| joinGroupParams | JoinGroupParams | yes | Param of joining 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 { JoinGroupParams } from "im_electron_sdk/dist/interfaces";
let groupId = ''
let param: JoinGroupParams = {
groupId: groupId, // required
helloMsg: '', // optional
data: ''// optional
}
const { code } = await timRenderInstance.TIMGroupJoin(param)
if (code == 0) {
// success
}