API Overview
Message Callbacks
Status Codes
- Android
- iOS
- JavaScript
- Flutter
- ReactNative
Not supported.
Not supported.
Subscribe to the online status of specified users. The current status is returned immediately after a successful subscription; subsequent changes are available through the status listener.
Parameters
| Name | Type | Required | Default | Description | Version |
|---|---|---|---|---|---|
| params | Object | Yes | Subscription parameters. | 1.0.0 | |
| params.userIds | Array | Yes | User ID list. | 1.0.0 |
Callback
| Property | Type | Description | Version |
|---|---|---|---|
| result | Object | Subscription 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.subUserStatus(params).then((result) => {
console.log('subUserStatus', result);
// result.users => [{ userId: '6UXQ4u8q57G', status: 1 }]
}, (error) => {
console.log(error);
});
Not supported.
Not supported.