setGroupMemberInfo
功能介绍
说明
修改群成员信息。
注意
群主可以修改管理员和普通成员信息;管理员可以修改普通成员信息;
相关回调:
onGroupMemberInfoChanged
- iOS
- Android
- Flutter
- uni-app
- Browser/Electron/MiniProgram
- React-Native
- Unity
函数原型
Future<dynamic> setGroupMemberInfo({
required SetGroupMembersInfo groupMembersInfo,
String? operationID,
})
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
groupMembersInfo | SetGroupMembersInfo | 是 | 成员信息 |
返回结果
参数名称 | 参数类型 | 描述 |
---|---|---|
~ | ~ | 无异常抛出则操作成功 |
代码示例
await OpenIM.iMManager.groupManager.setGroupMemberInfo(
groupMembersInfo: ,
);
// todo
函数原型
- (void)setGroupMemberInfo:(OIMSetGroupMembersInfo *)groupMembersInfo
onSuccess:(nullable OIMSuccessCallback)onSuccess
onFailure:(nullable OIMFailureCallback)onFailure;
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
groupMembersInfo | OIMSetGroupMembersInfo | 是 | 成员信息 |
返回结果
参数名称 | 参数类型 | 描述 |
---|---|---|
onSuccess | OIMSuccessCallback | 成功返回 |
onFailure | OIMFailureCallback | 失败返回 |
代码示例
[OIMManager.manager setGroupMemberInfo:
onSuccess:^(NSString * _Nullable data) {
} onFailure:^(NSInteger code, NSString * _Nullable msg) {
}];
函数原型
public void setGroupMemberInfo(SetGroupMemberInfo info,OnBase<String> callBack)
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
groupMembersInfo | SetGroupMemberInfo | 是 | 成员信息 |
返回结果
代码示例
OpenIMClient.getInstance().groupManager.setGroupMemberInfo(groupInfo, new OnBase<String>() {
@Override
public void onError(int code, String error) {
// todo: 处理错误信息
}
@Override
public void onSuccess(String data) {
// todo: 请求成功
}
});
函数原型
IMSDK.setGroupMemberInfo({
groupID: string;
userID: string;
nickname?: string;
faceURL?: string;
roleLevel?: GroupMemberRole;
ex?: string;
}, operationID?: string): Promise<WsResponse>
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
groupID | string | 是 | 群ID |
userID | string | 是 | 用户 ID |
nickname | string | 否 | 群成员昵称 |
faceURL | string | 否 | 群成员头像URL |
roleLevel | string | 否 | 群成员角色 |
ex | string | 否 | 群成员扩展信息 |
返回结果
参数名称 | 参数类型 | 描述 |
---|---|---|
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.setGroupMemberInfo({
groupID: '',
userID: '',
nickname: 'new name',
})
.then(() => {
// 调用成功
})
.catch(({ errCode, errMsg }) => {
// 调用失败
});
函数原型
IMSDK.asyncApi('setGroupMemberInfo', operationID: string, {
groupID: string;
userID: string;
nickname?: string;
faceURL?: string;
roleLevel?: GroupMemberRole;
ex?: string;
}): Promise<void>
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
operationID | string | 是 | 操作 ID,用于定位问题,保持唯一,建议用当前时间和随机数 |
groupID | string | 是 | 群ID |
userID | string | 是 | 用户 ID |
nickname | string | 否 | 群成员昵称 |
faceURL | string | 否 | 群成员头像URL |
roleLevel | string | 否 | 群成员角色 |
ex | string | 否 | 群成员扩展信息 |
返回结果
通过
openim-uniapp-polyfill
包将函数 Promise 化,调用时需要使用then
和catch
判断并处理成功和失败回调。
参数名称 | 参数类型 | 描述 |
---|---|---|
Promise.then() | Promise<void> | 调用成功回调 |
Promise.catch() | Promise<CatchResponse> | 调用失败回调 |
代码示例
import IMSDK from 'openim-uniapp-polyfill';
IMSDK.asyncApi('setGroupMemberInfo', IMSDK.uuid(), {
groupID: '',
userID: '',
nickname: 'new name',
})
.then(() => {
// 调用成功
})
.catch(({ errCode, errMsg }) => {
// 调用失败
});
函数原型
OpenIMSDKRN.setGroupMemberInfo({
groupID: string;
userID: string;
nickname?: string;
faceURL?: string;
roleLevel?: GroupMemberRole;
ex?: string;
}, operationID: string): Promise<void>
输入参数
参数名称 | 参数类型 | 是否必填 | 描述 |
---|---|---|---|
groupID | string | 是 | 群ID |
userID | string | 是 | 用户 ID |
nickname | string | 否 | 群成员昵称 |
faceURL | string | 否 | 群成员头像URL |
roleLevel | string | 否 | 群成员角色 |
ex | string | 否 | 群成员扩展信息 |
operationID | string | 是 | 操作 ID,用于定位问题,保持唯一,建议用当前时间和随机数 |
返回结果
参数名称 | 参数类型 | 描述 |
---|---|---|
Promise.then() | Promise<void> | 调用成功回调 |
Promise.catch() | Promise<CatchResponse> | 调用失败回调 |
代码示例
import OpenIMSDKRN from "open-im-sdk-rn";
OpenIMSDKRN.setGroupMemberInfo({
groupID: '',
userID: '',
nickname: 'new name',
}, 'operationID')
.then(() => {
// 调用成功
})
.catch(({ errCode, errMsg }) => {
// 调用失败
});