setGroupMemberInfo

Description

info

Modify group member information.

Note

The group owner can modify administrator and ordinary member information; administrators can modify ordinary member information.

Related Callbacks:
onGroupMemberInfoChanged

iOS

Function Prototype

  Future<dynamic> setGroupMemberInfo({
    required SetGroupMembersInfo groupMembersInfo,
    String? operationID,
  })

Input Parameters

Parameter Name	Parameter Type	Required	Description
groupMembersInfo	SetGroupMembersInfo	Yes	Member Info

Return Result

Parameter Name	Parameter Type	Description
~	~	Operation successful if no exception is thrown

Code Example

    await OpenIM.iMManager.groupManager.setGroupMemberInfo(
      groupMembersInfo: ,
    );
    // todo

Android

Function Prototype

- (void)setGroupMemberInfo:(OIMSetGroupMembersInfo *)groupMembersInfo
                 onSuccess:(nullable OIMSuccessCallback)onSuccess
                 onFailure:(nullable OIMFailureCallback)onFailure;

Input Parameters

Parameter Name	Parameter Type	Required	Description
groupMembersInfo	OIMSetGroupMembersInfo	Yes	Member Info

Return Result

Parameter Name	Parameter Type	Description
onSuccess	OIMSuccessCallback	Success
onFailure	OIMFailureCallback	Failure

Code Example

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

Flutter

Function Prototype

 public void setGroupMemberInfo(SetGroupMemberInfo info,OnBase<String> callBack)

Input Parameters

Parameter Name	Parameter Type	Required	Description
groupMembersInfo	SetGroupMemberInfo	Yes	Member Info

Return Result

Code Example

OpenIMClient.getInstance().groupManager.setGroupMemberInfo(groupInfo, new OnBase<String>() {
    @Override
    public void onError(int code, String error) {
      // todo: handle error info
    }
    @Override
    public void onSuccess(String data) {
      // todo: request successful
    }
});

uni-app

Function Prototype

IMSDK.setGroupMemberInfo({
  groupID: string;
  userID: string;
  nickname?: string;
  faceURL?: string;
  roleLevel?: GroupMemberRole;
  ex?: string;
}, operationID?: string): Promise<WsResponse>

Input Parameters

Parameter Name	Parameter Type	Required	Description
groupID	string	Yes	Group ID
userID	string	Yes	User ID
nickname	string	No	Group member nickname
faceURL	string	No	Group member avatar URL
roleLevel	string	No	Group member role
ex	string	No	Group member extension info

Return Result

Parameter Name	Parameter Type	Description
Promise.then()	Promise<WsResponse>	Success callback
Promise.catch()	Promise<WsResponse>	Failure callback

Code Example

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 { getSDK } from '@openim/client-sdk';
// const IMSDK = getSDK();

IMSDK.setGroupMemberInfo({
  groupID: '',
  userID: '',
  nickname: 'new name',
})
  .then(() => {
    // Success
  })
  .catch(({ errCode, errMsg }) => {
    // Failure
  });

Browser/Electron/MiniProgram

Function Prototype

IMSDK.asyncApi('setGroupMemberInfo', operationID: string, {
  groupID: string;
  userID: string;
  nickname?: string;
  faceURL?: string;
  roleLevel?: GroupMemberRole;
  ex?: string;
}): Promise<void>

Input Parameters

Parameter Name	Parameter Type	Required	Description
operationID	string	Yes	Operation ID, used to pinpoint issues, keep unique, prefer time+random
groupID	string	Yes	Group ID
userID	string	Yes	User ID
nickname	string	No	Group member nickname
faceURL	string	No	Group member avatar URL
roleLevel	string	No	Group member role
ex	string	No	Group member extension info

Return Result

Use the openim-uniapp-polyfill package to make the function Promise. When calling, you need to use then and catch to determine and handle success and failure callbacks.

Parameter Name	Parameter Type	Description
Promise.then()	Promise<void>	Success callback
Promise.catch()	Promise<CatchResponse>	Failure callback

Code Example

import IMSDK from 'openim-uniapp-polyfill';

IMSDK.asyncApi('setGroupMemberInfo', IMSDK.uuid(), {
  groupID: '',
  userID: '',
  nickname: 'new name',
})
  .then(() => {
    // Success
  })
  .catch(({ errCode, errMsg }) => {
    // Failure
  });

React-Native

Function Prototype

OpenIMSDK.setGroupMemberInfo({
  groupID: string;
  userID: string;
  nickname?: string;
  faceURL?: string;
  roleLevel?: GroupMemberRole;
  ex?: string;
}, operationID?: string): Promise<void>

Input Parameters

Parameter Name	Parameter Type	Required	Description
groupID	string	Yes	Group ID
userID	string	Yes	User ID
nickname	string	No	Group member nickname
faceURL	string	No	Group member avatar URL
roleLevel	string	No	Group member role
ex	string	No	Group member extension info
operationID	string	No	Operation ID, used to pinpoint issues, keep unique, prefer time+random

Return Result

Parameter Name	Parameter Type	Description
Promise.then()	Promise<void>	Success callback
Promise.catch()	Promise<OpenIMApiError>	Failure callback

Code Example

import OpenIMSDK from "@openim/rn-client-sdk";

OpenIMSDK.setGroupMemberInfo({
  groupID: '',
  userID: '',
  nickname: 'new name',
})
  .then(() => {
    // Success
  })
  .catch((error) => {
    // Failure
  });

Unity

Function Prototype

public static void SetGroupMemberInfo(OnBase<bool> cb, SetGroupMemberInfo groupMemberInfo)

Input Parameters

Parameter Name	Parameter Type	Required	Description
cb	OnBase	Yes	Callback
groupMemberInfo	SetGroupMemberInfo	Yes	Member Setup

Return Result

Code Example

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

},new SetGroupMemberInfo(){

});