setGroupInfo

功能介绍

说明

设置群信息，包括群头像、名称、公告、简介、扩展字段等。

注意

管理员和群主才有设置权限。

相关回调:
onGroupInfoChanged

iOS

函数原型

 Future<dynamic> setGroupInfo(GroupInfo groupInfo,{
    String? operationID,
  })

输入参数

参数名称	参数类型	是否必填	描述
groupID	NSString	是	群 ID
groupInfo	GroupInfo	是	群 信息

返回结果

参数名称	参数类型	描述
~	~	无异常抛出则操作成功

代码示例

    await OpenIM.iMManager.groupManager.setGroupInfo();
    // todo

Android

函数原型

- (void)setGroupInfo:(OIMGroupInfo *)groupInfo
           onSuccess:(nullable OIMSuccessCallback)onSuccess
           onFailure:(nullable OIMFailureCallback)onFailure;

输入参数

参数名称	参数类型	是否必填	描述
groupID	NSString	是	群 ID
groupInfo	OIMGroupInfo	是	群 信息

返回结果

参数名称	参数类型	描述
onSuccess	OIMSuccessCallback	成功返回
onFailure	OIMFailureCallback	失败返回

代码示例

OIMGroupInfo *param = [OIMGroupInfo new];
param.introduction = @"";

[OIMManager.manager setGroupInfo:param
                        onSuccess:^(NSString * _Nullable data) {
} onFailure:^(NSInteger code, NSString * _Nullable msg) {
}];

Flutter

函数原型

public void setGroupInfo(GroupInfo groupInfo, OnBase<String> callBack)

输入参数

参数名称	参数类型	是否必填	描述
callBack	OnBase	是	回调接口
groupInfo	GroupInfo	是	群 信息

返回结果

代码示例

OpenIMClient.getInstance().groupManager.setGroupInfo(groupInfo, new OnBase<String>() {
    @Override
    public void onError(int code, String error) {
      // todo: 处理错误信息
    }
    @Override
    public void onSuccess(String data) {
      // todo: 请求成功
    }
});

uni-app

函数原型

IMSDK.setGroupInfo({
  groupID: string;
  faceURL?: string;
  groupName?: string;
  introduction?: string;
  notification?: string;
  needVerification?: GroupVerificationType;
  applyMemberFriend?: AllowType;
  lookMemberInfo?: AllowType;
  ex?: string;
}, operationID?: string): Promise<WsResponse>

输入参数

参数名称	参数类型	是否必填	描述
groupID	string	是	群组 ID
faceURL	string	否	群头像
groupName	string	否	群名称
notification	string	否	群公告
introduction	string	否	群简介
needVerification	GroupVerification	否	进群验证方式
lookMemberInfo	AllowType	否	是否允许查看成员资料
applyMemberFriend	AllowType	否	是否允许群内添加好友
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.setGroupInfo({
  groupID: 'groupID',
  groupName: 'new name',
})
  .then(() => {
    // 调用成功
  })
  .catch(({ errCode, errMsg }) => {
    // 调用失败
  });

Browser/Electron/MiniProgram

函数原型

IMSDK.asyncApi('setGroupInfo', operationID: string, {
  groupID: string;
  faceURL?: string;
  groupName?: string;
  introduction?: string;
  notification?: string;
  needVerification?: GroupVerificationType;
  applyMemberFriend?: AllowType;
  lookMemberInfo?: AllowType;
  ex?: string;
}): Promise<void>

输入参数

参数名称	参数类型	是否必填	描述
operationID	string	是	操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数
groupID	string	是	群组 ID
faceURL	string	否	群头像
groupName	string	否	群名称
notification	string	否	群公告
introduction	string	否	群简介
needVerification	GroupVerification	否	进群验证方式
lookMemberInfo	AllowType	否	是否允许查看成员资料
applyMemberFriend	AllowType	否	是否允许群内添加好友
ex	string	否	扩展字段

返回结果

通过openim-uniapp-polyfill包将函数 Promise 化，调用时需要使用then和catch判断并处理成功和失败回调。

参数名称	参数类型	描述
Promise.then()	Promise<void>	调用成功回调
Promise.catch()	Promise<CatchResponse>	调用失败回调

代码示例

import IMSDK from 'openim-uniapp-polyfill';

IMSDK.asyncApi('setGroupInfo', IMSDK.uuid(), {
  groupID: 'groupID',
  groupName: 'new name',
})
  .then(() => {
    // 调用成功
  })
  .catch(({ errCode, errMsg }) => {
    // 调用失败
  });

React-Natvie

函数原型

OpenIMSDKRN.setGroupInfo({
  groupID: string;
  faceURL?: string;
  groupName?: string;
  introduction?: string;
  notification?: string;
  needVerification?: GroupVerificationType;
  applyMemberFriend?: AllowType;
  lookMemberInfo?: AllowType;
  ex?: string;
}, operationID: string): Promise<void>

输入参数

参数名称	参数类型	是否必填	描述
operationID	string	是	操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数
groupID	string	是	群组 ID
faceURL	string	否	群头像
groupName	string	否	群名称
notification	string	否	群公告
introduction	string	否	群简介
needVerification	GroupVerification	否	进群验证方式
lookMemberInfo	AllowType	否	是否允许查看成员资料
applyMemberFriend	AllowType	否	是否允许群内添加好友
ex	string	否	扩展字段

返回结果

参数名称	参数类型	描述
Promise.then()	Promise<void>	调用成功回调
Promise.catch()	Promise<CatchResponse>	调用失败回调

代码示例

import OpenIMSDKRN from 'open-im-sdk-rn';

OpenIMSDKRN.setGroupInfo(
  {
    groupID: 'groupID',
    groupName: 'new name',
  },
  'operationID'
)
  .then(() => {
    // 调用成功
  })
  .catch(({ errCode, errMsg }) => {
    // 调用失败
  });

Unity

函数原型

public static void SetGroupInfo(OnBase<bool> cb, GroupInfo groupInfo)

输入参数

参数名称	参数类型	是否必填	描述
cb	onBase	是	回调
groupInfo	GroupInfo	是	群 信息

返回结果

代码示例

IMSDK.SetGroupInfo((suc,errCode,errMsg)=>{

},new GroupInfo(){

});