subscribeUsersStatus

功能介绍

说明

订阅指定用户的在线状态，并返回其在线状态。

注意

每个用户订阅人数不能超过3000，如超过则按照订阅时间淘汰。

相关回调:
onUserStatusChanged

iOS

函数原型

 Future<List<UserStatusInfo>> subscribeUsersStatus(
    List<String> userIDs, {
    String? operationID,
  })

输入参数

参数名称	参数类型	是否必填	描述
userIDs	List<String>	是	用户 ID 列表

返回结果

参数名称	参数类型	描述
then	List<UserStatusInfo >	调用成功回调
onError	Function	调用失败回调

代码示例

await OpenIM.iMManager.userManager.subscribeUsersStatus([]);
// todo

Android

函数原型

- (void)subscribeUsersStatus:(NSArray<NSString *> *)userIDs
                   onSuccess:(nullable OIMUserStatusInfosCallback)onSuccess
                   onFailure:(nullable OIMFailureCallback)onFailure;

输入参数

参数名称	参数类型	是否必填	描述
userIDs	NSArray<NSString *>	是	用户 ID 列表

返回结果

参数名称	参数类型	描述
onSuccess	NSArray<OIMUserStatusInfo >	成功返回
onFailure	OIMFailureCallback	失败返回

代码示例

[OIMManager.manager subscribeUsersStatus:@[]
                                   onSuccess:^(NSArray<OIMUserStatusInfo *> * _Nullable statusInfos) {

} onFailure:^(NSInteger code, NSString * _Nullable msg) {

}];

Flutter

函数原型

    public void subscribeUsersOnlineStatus(OnBase<List<UsersOnlineStatus>> callBack, List<String> uid)

输入参数

参数名称	参数类型	是否必填	描述
callback	OnBase<List<UsersOnlineStatus>>	是	用户 ID
ids	List<String>	是	用户 ID

代码示例

        OpenIMClient.getInstance().userInfoManager.subscribeUsersOnlineStatus(new OnBase<List<UsersOnlineStatus>>() {
            @Override
            public void onError(int code, String error) {

            }

            @Override
            public void onSuccess(List<UsersOnlineStatus> data) {
            // todo
            }
        },ids);

uni-app

函数原型

IMSDK.subscribeUsersStatus(userIDList: string[], operationID?: string): Promise<WsResponse<UserOnlineState[]>>

输入参数

参数名称	参数类型	是否必填	描述
userIDList	string[]	是	用户 ID 列表

返回结果

参数名称	参数类型	描述
Promise.then()	Promise<WsResponse<UserOnlineState[]>>	用户在线状态详情列表
Promise.catch()	Promise<WsResponse>	调用失败回调

代码示例

import { getSDK } from 'open-im-sdk-wasm';
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();

const userIDList = ['userID1', 'userID2'];
IMSDK.subscribeUsersStatus(userIDList)
  .then(({ data }) => {
    // data: 用户在线状态详情列表
  })
  .catch(({ errCode, errMsg }) => {
    // 调用失败
  });

Browser/Electron/MiniProgram

函数原型

IMSDK.asyncApi('subscribeUsersStatus', operationID: string, userIDList: string[]): Promise<UserOnlineState[]>

输入参数

参数名称	参数类型	是否必填	描述
operationID	string	是	操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数
userIDList	string[]	是	用户 ID 列表

返回结果

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

参数名称	参数类型	描述
Promise.then()	Promise<UserOnlineState[]>	用户在线状态详情列表
Promise.catch()	Promise<CatchResponse>	调用失败回调

代码示例

import IMSDK from 'openim-uniapp-polyfill';

const userIDList = ['userID1', 'userID2'];
IMSDK.asyncApi('subscribeUsersStatus', IMSDK.uuid(), userIDList)
  .then((data) => {
    // data: 用户在线状态详情列表
  })
  .catch(({ errCode, errMsg }) => {
    // 调用失败
  });

React-Native

函数原型

OpenIMSDKRN.subscribeUsersStatus(userIDList: string[], operationID: string): Promise<UserOnlineState[]>

输入参数

参数名称	参数类型	是否必填	描述
userIDList	string[]	是	用户 ID 列表
operationID	string	是	操作 ID，用于定位问题，保持唯一，建议用当前时间和随机数

返回结果

参数名称	参数类型	描述
Promise.then()	Promise<UserOnlineState[]>	用户在线状态详情列表
Promise.catch()	Promise<CatchResponse>	调用失败回调

代码示例

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

const userIDList = ['userID1', 'userID2'];
const data = await OpenIMSDKRN.subscribeUsersStatus(userIDList, 'operationID');
  .then((data) => {
    // data: 用户在线状态详情列表
  })
  .catch(({ errCode, errMsg }) => {
    // 调用失败
  });

Unity

函数原型

public static void SubscribeUsersStatus(OnOnlineStatusList cb, string[] userIDs)

输入参数

参数名称	参数类型	是否必填	描述
cb	OnOnlineStatusList	是	用户 ID
userIDS	string[]	是	用户 ID

代码示例

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

},userIDS);