kickGroupMember
功能介绍
说明
把群成员从群组中移除。
注意
(1)群主和群管理员可移除普通成员,群主可移除管理员和普通成员。
- iOS
- Android
- Flutter
- uni-app
- Browser/Electron/MiniProgram
- React-Native
- Unity
函数原型
Future<List<GroupInviteResult>> kickGroupMember({
required String groupID,
required List<String> userIDList,
String? reason,
String? operationID,
})
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
groupID | String | 是 | 群ID |
reason | Sting | 否 | 踢出原因 |
userIDList | List<String> | 是 | 踢出用户 userID 列表 |
返回结果
参数名称 | 参数类型 | 描述 |
---|---|---|
~ | GroupInviteResult | 成功返回 |
GroupInviteResult
字段名称 | 字段类型 | 描述 |
---|---|---|
userID | String | 用户ID |
result | Int | 执行结果 |
代码示例
List<GroupInviteResult> list = await OpenIM.iMManager.groupManager.kickGroupMember(
groupID: 'groupID',
userIDList: [],
reason: ''
);
// todo
函数原型
- (void)kickGroupMember:(NSString *)groupID
reason:(NSString * _Nullable)reason
uids:(NSArray *)usersID
onSuccess:(nullable OIMSimpleResultsCallback)onSuccess
onFailure:(nullable OIMFailureCallback)onFailure;
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
groupID | NSString | 是 | 群ID |
reason | NSSting | 否 | 踢出原因 |
usersID | NSArray<NSString *> | 是 | 踢出用户 userID 列表 |
返回结果
参数名称 | 参数类型 | 描述 |
---|---|---|
onSuccess | OIMSimpleResultInfo | 成功返回 |
onFailure | OIMFailureCallback | 失败返回 |
OIMSimpleResultInfo
字段名称 | 字段类型 | 描述 |
---|---|---|
userID | NSString | 用户ID |
result | NSInteger | 执行结果 |
代码示例
[OIMManager.manager kickGroupMember:@""
reason:@""
uids:@[@""]
onSuccess:^(NSArray<OIMSimpleResultInfo *> * _Nullable results) {
} onFailure:^(NSInteger code, NSString * _Nullable msg) {
}];
函数原型
public void kickGroupMember(OnBase<List<GroupInviteResult>> base, String groupId, List<String> uidList, String reason)
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
callBack | OnBase<List<ResultInfo>> | 是 | 回调接口 |
groupId | String | 是 | 群ID |
reason | Sting | 否 | 信息 |
uidList | List<String> | 是 | 用户 ID 列表 |
返回结果
代码示例
OpenIMClient.getInstance().groupManager.kickGroupMember(new OnBase<List<ResultInfo>>() {
@Override
public void onError(int code, String error) {
}
@Override
public void onSuccess(List<GroupInviteResult> data) {
}
}, groupId, uidList, reason)
函数原型
IMSDK.kickGroupMember({
groupID: string;
reason: string;
userIDList: string[];
}, operationID?: string): Promise<WsResponse>
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
groupID | string | 是 | 群ID |
reason | string | 是 | 踢出原因 |
userIDList | string[] | 是 | 提出用户 ID 列表 |
返回结果
参数名称 | 参数类型 | 描述 |
---|---|---|
Promise.then() | Promise<WsResponse> | 调用成功回调 |
Promise.catch() | Promise<WsResponse> | 调用失败回调 |
代码示例
import { getSDK } from '@openim/wasm-client-sdk';
const IMSDK = getSDK();
// use in electron with ffi
// import { getWithRenderProcess } from '@openim/electron-client-sdk/lib/render';
// const { instance: IMSDK } = getWithRenderProcess();
// use in mini program
// import { OpenIMSDK } from 'open-im-sdk';
// const IMSDK = new OpenIMSDK();
IMSDK.kickGroupMember({
groupID: '',
reason: '',
userIDList: ['userID'],
})
.then(() => {
// 调用成功
})
.catch(({ errCode, errMsg }) => {
// 调用失败
});
函数原型
IMSDK.asyncApi('kickGroupMember', operationID: string, {
groupID: string;
reason: string;
userIDList: string[];
}): Promise<void>
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
operationID | string | 是 | 操作 ID,用于定位问题,保持唯一,建议用当前时间和随机数 |
groupID | string | 是 | 群ID |
reason | string | 是 | 踢出原因 |
userIDList | string[] | 是 | 提出用户 ID 列表 |
返回结果
通过
openim-uniapp-polyfill
包将函数 Promise 化,调用时需要使用then
和catch
判断并处理成功和失败回调。
参数名称 | 参数类型 | 描述 |
---|---|---|
Promise.then() | Promise<void> | 调用成功回调 |
Promise.catch() | Promise<CatchResponse> | 调用失败回调 |
代码示例
import IMSDK from 'openim-uniapp-polyfill';
IMSDK.asyncApi('kickGroupMember', IMSDK.uuid(), {
groupID: '',
reason: '',
userIDList: ['userID'],
})
.then(() => {
// 调用成功
})
.catch(({ errCode, errMsg }) => {
// 调用失败
});
函数原型
OpenIMSDKRN.kickGroupMember({
groupID: string,
reason: string,
userIDList: string[],
}, operationID: string): Promise<void>
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
groupID | string | 是 | 群ID |
reason | string | 是 | 踢出原因 |
userIDList | string[] | 是 | 提出用户 ID 列表 |
operationID | string | 是 | 操作 ID,用于定位问题,保持唯一,建议用当前时间和随机数 |
返回结果
参数名称 | 参数类型 | 描述 |
---|---|---|
Promise.then() | Promise<void> | 调用成功回调 |
Promise.catch() | Promise<CatchResponse> | 调用失败回调 |
代码示例
import OpenIMSDKRN from "open-im-sdk-rn";
OpenIMSDKRN.kickGroupMember({
groupID: '',
reason: '',
userIDList: ['userID'],
}, 'operationID')
.then(() => {
// 调用成功
})
.catch(({ errCode, errMsg }) => {
// 调用失败
});