getSpecifiedGroupMembersInfo

Description

info

Get the specified group member information.

Note

(1) The caller must join this group before calling;
(2) It is recommended that the group member list is a maximum of 10,000 at a time.

iOS

Function Prototype

Future<List<GroupMembersInfo>> getGroupMembersInfo({
    required String groupID,
    required List<String> userIDList,
    String? operationID,
  })

Input Parameters

Parameter Name	Parameter Type	Required	Description
groupID	String	Yes	Group ID
userIDList	List<String>	Yes	List of member IDs

Return Result

Parameter Name	Parameter Type	Description
~	List<GroupMembersInfo>	Success

Code Example

    List<GroupMembersInfo> list = await OpenIM.iMManager.groupManager.getGroupMembersInfo(
      groupID: 'groupID',
      userIDList: ['1129'],
    );
    // todo

Android

Function Prototype

- (void)getSpecifiedGroupMembersInfo:(NSString *)groupID
                             usersID:(NSArray <NSString *> *)usersID
                           onSuccess:(nullable OIMGroupMembersInfoCallback)onSuccess
                           onFailure:(nullable OIMFailureCallback)onFailure;

Input Parameters

Parameter Name	Parameter Type	Required	Description
groupID	NSString	Yes	Group ID
usersID	NSArray <NSString *>	Yes	List of member IDs

Return Result

Parameter Name	Parameter Type	Description
onSuccess	NSArray< OIMGroupMemberInfo *>	Success
onFailure	OIMFailureCallback	Failure

Code Example

[OIMManager.manager getSpecifiedGroupMembersInfo:@""
                                         usersID:@[]
                                       onSuccess:^(NSArray<OIMGroupMemberInfo *> * _Nullable groupMembersInfo) {
} onFailure:^(NSInteger code, NSString * _Nullable msg) {
}];

Flutter

Function Prototype

 public void getGroupMembersInfo(OnBase<List<GroupMembersInfo>> callBack, String groupId, List<String> uidList)

Input Parameters

Parameter Name	Parameter Type	Required	Description
callBack	OnBase<List<GroupMembersInfo>>	Yes	Callback interface
groupId	String	Yes	Group ID
uidList	List<String>	Yes	List of member IDs

Return Result

Code Example

  OpenIMClient.getInstance().groupManager.getGroupMembersInfo(new OnBase<List<GroupMembersInfo>>() {
            @Override
            public void onError(int code, String error) {

            }

            @Override
            public void onSuccess(List<GroupMembersInfo> data) {

            }
        },groupId,uidList)

uni-app

Function Prototype

IMSDK.getSpecifiedGroupMembersInfo({
  groupID: string;
  userIDList: string[];
}, operationID?: string): Promise<WsResponse<GroupMemberItem[]>>

Input Parameters

Parameter Name	Parameter Type	Required	Description
groupID	string	Yes	Group ID
userIDList	string[]	Yes	List of group member IDs

Return Result

Parameter Name	Parameter Type	Description
Promise.then()	Promise<WsResponse<GroupMemberItem[]>>	Group member list
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.getSpecifiedGroupMembersInfo({
  groupID: '',
  userIDList: ['userID'],
})
  .then(({ data }) => {
    // Success
  })
  .catch(({ errCode, errMsg }) => {
    // Failure
  });

Browser/Electron/MiniProgram

Function Prototype

IMSDK.asyncApi('getSpecifiedGroupMembersInfo', operationID: string, {
  groupID: string;
  userIDList: string[];
}): Promise<GroupMemberItem[]>

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
userIDList	string[]	Yes	List of group member IDs

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<GroupMemberItem[]>	Group member list
Promise.catch()	Promise<CatchResponse>	Failure callback

Code Example

import IMSDK from 'openim-uniapp-polyfill';

IMSDK.asyncApi('getSpecifiedGroupMembersInfo', IMSDK.uuid(), {
  groupID: '',
  userIDList: ['userID'],
})
  .then((data) => {
    // Success
  })
  .catch(({ errCode, errMsg }) => {
    // Failure
  });

React-Native

Function Prototype

OpenIMSDK.getSpecifiedGroupMembersInfo({
  groupID: string,
  userIDList: string[], 
}, operationID?: string): Promise<GroupMemberItem[]>

Input Parameters

Parameter Name	Parameter Type	Required	Description
groupID	string	Yes	Group ID
userIDList	string[]	Yes	List of group member IDs
operationID	string	No	Operation ID, used to pinpoint issues, keep unique, prefer time+random

Return Result

Parameter Name	Parameter Type	Description
Promise.then()	Promise<GroupMemberItem[]>	Group member list
Promise.catch()	Promise<OpenIMApiError>	Failure callback

Code Example

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

OpenIMSDK.getSpecifiedGroupMembersInfo({
  groupID: '',
  userIDList: ['userID'],
})
  .then((data) => {
    // Success
  })
  .catch((error) => {
    // Failure
  });

Unity

Function Prototype

public static void GetSpecifiedGroupMembersInfo(OnBase<List<GroupMember>> cb, string groupId, string[] userIdList)

Input Parameters

Parameter Name	Parameter Type	Required	Description
cb	OnBase<List<GroupMembersInfo>>	Yes	Callback interface
groupId	string	Yes	Group ID
userIdList	string[]	Yes	List of member IDs

Return Result

Code Example

IMSDK.GetSpecifiedGroupMembersInfo((list,errCode,errMsg)=>{

},groupId,userIdList);