getSubscribeUsersStatus

Description

info

Get the online status of all subscribed users.

Note

Retrieve the online status of all subscribed users at once, returning a maximum of 3000.

iOS

Function Prototype

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

Input Parameters

None

Return Result

Parameter Name	Parameter Type	Description
then	List<UserStatusInfo >	Success callback
onError	Function	Failure callback

Code Example

await OpenIM.iMManager.userManager.getSubscribeUsersStatus();
// todo

Android

Function Prototype

- (void)getSubscribeUsersStatusWithOnSuccess:(nullable OIMUserStatusInfosCallback)onSuccess
                                   onFailure:(nullable OIMFailureCallback)onFailure;

Input Parameters

None

Return Result

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

Code Example

[OIMManager.manager getSubscribeUsersStatusWithOnSuccess:^(NSArray<OIMUserStatusInfo *> * _Nullable statusInfos) {

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

}];

Flutter

Function Prototype

public void getSubscribeOnlineUsersStatus(OnBase<List<UsersOnlineStatus>> callBack)

Input Parameters

None

Return Result

Parameter Name	Parameter Type	Description
callBack	OnBase<List<UsersOnlineStatus>>	Success callback

Code Example

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

                }

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

uni-app

Function Prototype

IMSDK.getSubscribeUsersStatus(operationID?: string): Promise<WsResponse<UserOnlineState[]>>

Input Parameters

None

Return Result

Parameter Name	Parameter Type	Description
Promise.then()	Promise<WsResponse<UserOnlineState[]>>	Subscribed user online status details 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.getSubscribeUsersStatus()
  .then(({ data }) => {
    // data: Subscribed user online status details list
  })
  .catch(({ errCode, errMsg }) => {
    // Call failed
  });

Browser/Electron/MiniProgram

Function Prototype

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

Input Parameters

Parameter Name	Parameter Type	Required	Description
operationID	string	Yes	Operation ID, used to pinpoint issues, keep unique, prefer time+random

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<UserOnlineState[]>	Subscribed user online status details list
Promise.catch()	Promise<CatchResponse>	Failure callback

Code Example

import IMSDK from 'openim-uniapp-polyfill';

IMSDK.asyncApi('getSubscribeUsersStatus', IMSDK.uuid())
  .then((data) => {
    // data: Subscribed user online status details list
  })
  .catch(({ errCode, errMsg }) => {
    // Call failed
  });

React-Native

Function Prototype

OpenIMSDK.getSubscribeUsersStatus(operationID?: string): Promise<UserOnlineState[]>

Input Parameters

Parameter Name	Parameter Type	Required	Description
operationID	string	No	Operation ID, used to pinpoint issues, keep unique, prefer time+random

Return Result

Parameter Name	Parameter Type	Description
Promise.then()	Promise<UserOnlineState[]>	Subscribed user online status details list
Promise.catch()	Promise<OpenIMApiError>	Failure callback

Code Example

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

OpenIMSDK.getSubscribeUsersStatus()
  .then((data) => {
    // data: Subscribed user online status details list
  })
  .catch((error) => {
    // Call failed
  });

Unity

Function Prototype

public static void GetSubscribeUsersStatus(OnBase<List<OnlineStatus>> cb)

Input Parameters

Parameter Name	Parameter Type	Description
cb	OnBase<List<UsersOnlineStatus>>	Callback

Code Example

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

});