- Android
- iOS
- JavaScript
- Flutter
- ReactNative
Query the online status of specified users. Batch queries are supported.
API Definition
/**
* query user status
* @param userIdList list of user IDs to query
* @param callback result callback
*/
void getUserStatus(List<String> userIdList, JIMConst.IResultListCallback<UserStatus> callback);
Example
List<String> userIdList = new ArrayList<>();
userIdList.add("userId1");
userIdList.add("userId2");
userIdList.add("userId3");
userIdList.add("userId4");
JIM.getInstance().getUserInfoManager().getUserStatus(userIdList, new JIMConst.IResultListCallback<UserStatus>() {
@Override
public void onSuccess(List<UserStatus> data, boolean isFinish) {
}
@Override
public void onError(int errorCode) {
}
});
Query the online status of specified users. Batch queries are supported.
API Definition
/// query user status
/// - Parameters:
/// - userIdList: list of user IDs to query
/// - successBlock: success callback
/// - errorBlock: failure callback
- (void)getUserStatus:(NSArray <NSString *>*)userIdList
success:(void (^)(NSArray <JUserStatus *> *statusList))successBlock
error:(void (^)(JErrorCode code))errorBlock;
Example
NSArray *userIdList = @[@"userId1", @"userId2", @"userId3"];
[JIM.shared.userInfoManager getUserStatus:userIdList
success:^(NSArray<JUserStatus *> *statusList) {
} error:^(JErrorCode code) {
}];
Query the online status of specified users. Batch queries are supported.
Parameters
| Name | Type | Required | Default | Description | Version |
|---|---|---|---|---|---|
| params | Object | Yes | Query parameters. | 1.0.0 | |
| params.userIds | Array | Yes | User ID list. | 1.0.0 |
Callback
| Property | Type | Description | Version |
|---|---|---|---|
| result | Object | Query result. | 1.0.0 |
| result.users | Array | User status list. | 1.0.0 |
| result.users[].userId | String | User ID. | 1.0.0 |
| result.users[].status | Number | Status value: 1 for online and 2 for offline. | 1.0.0 |
Error Callback
| Name | Type | Description | Version |
|---|---|---|---|
| error | Object | A status code is returned when sending fails. Check error.msg directly or see status codes. | 1.0.0 |
Example
let params = {
userIds: ['6UXQ4u8q57G']
};
juggle.getUserStatus(params).then((result) => {
console.log('getUserStatus', result);
// result.users => [{ userId: '6UXQ4u8q57G', status: 1 }]
}, (error) => {
console.log(error);
});
Not supported.
Not supported.