User Status

chat.setSelfStatus(options);

// Set customStatus to an empty string '', this will clear your custom status
let promise = chat.setSelfStatus({customStatus: 'xxx'});
promise.then(function(imResponse) {
  console.log(imResponse.data);
  const { userID, statusType, customStatus } = imResponse.data;
  // userID - User ID
  // statusType - User status. The enumerated values and descriptions are as follows:
  // TencentCloudChat.TYPES.USER_STATUS_UNKNOWN - Unknown
  // TencentCloudChat.TYPES.USER_STATUS_ONLINE - Online
  // TencentCloudChat.TYPES.USER_STATUS_OFFLINE - Offline
  // TencentCloudChat.TYPES.USER_STATUS_UNLOGINED - Not Logged In
  // customStatus - User Custom Status
}).catch(function(imError) {
  console.warn('setSelfStatus error:', imError); // Failed to set user's custom status
});

chat.getUserStatus(options);

// Check your own user status
// userIDList includes only your own userID to query your own status
let promise = chat.getUserStatus({userIDList: [`${myUserID}`]});
promise.then(function(imResponse) {
   const { successUserList } = imResponse.data;
   successUserList.forEach((item) => {
     const { userID, statusType, customStatus } = item;
     // userID - User ID
     // statusType - User status, the enumerated values and descriptions are as follows:
     // TencentCloudChat.TYPES.USER_STATUS_UNKNOWN - Unknown
     // TencentCloudChat.TYPES.USER_STATUS_ONLINE - Online
     // TencentCloudChat.TYPES.USER_STATUS_OFFLINE - Offline
     // TencentCloudChat.TYPES.USER_STATUS_UNLOGINED - Not Logged In
     // customStatus - User Definition Status
   });
}).catch(function(imError) {
  console.warn('getUserStatus error:', imError); // Failed to obtain user status
});

// Query the status of other users
let promise = chat.getUserStatus({userIDList: ['user0', 'user1']});
promise.then(function(imResponse) {
   const { successUserList, failureUserList } = imResponse.data;
   // List of users with successful queries
   successUserList.forEach((item) => {
     const { userID, statusType, customStatus } = item;
     // userID - User ID
     // statusType - User status, the enumerated values and descriptions are as follows:
     // TencentCloudChat.TYPES.USER_STATUS_UNKNOWN - Unknown
     // TencentCloudChat.TYPES.USER_STATUS_ONLINE - Online
     // TencentCloudChat.TYPES.USER_STATUS_OFFLINE - Offline
     // TencentCloudChat.TYPES.USER_STATUS_UNLOGINED - Not Logged In
     // customStatus - User Definition Status
   });

   // List of users with failed queries
   failureUserList.forEach((item) => {
     const { userID, code, message } = item;
     // userID - User ID of the failed query
     // code - Error code of the failed query
     // message - Error message of the failed query
   });
}).catch(function(imError) {
  console.warn('getUserStatus error:', imError); // Failed to obtain user status
});

chat.subscribeUserStatus(options);

let promise = chat.subscribeUserStatus({userIDList: ['user0', 'user1']});
promise.then(function(imResponse) {
  const { failureUserList } = imResponse.data;
   // List of users with failed subscriptions
   failureUserList.forEach((item) => {
     const { userID, code, message } = item;
     // userID - User ID of the failed query
     // code - Error code of the failed query
     // message - Error message of the failed query
   });
}).catch(function(imError) {
  console.warn('subscribeUserStatus error:', imError); // Error information regarding the failure to subscribe to user status
});

chat.unsubscribeUserStatus(options);

// Unsubscribe current partial users
let promise = chat.unsubscribeUserStatus({userIDList: ['user0', 'user1']});
promise.then(function(imResponse) {
  const { failureUserList } = imResponse.data;
   // List of users with failed unsubscriptions
   failureUserList.forEach((item) => {
     const { userID, code, message } = item;
     // userID - User ID of the failed query
     // code - Error code of the failed query
     // message - Error message of the failed query
   });
}).catch(function(imError) {
  console.warn('unsubscribeUserStatus error:', imError); // Information related to the unsubscription failure
});

// Unsubscribe from all current subscriptions
let promise = chat.unsubscribeUserStatus();
promise.then(function(imResponse) {
  const { failureUserList } = imResponse.data;
   // List of users with failed unsubscriptions
   failureUserList.forEach((item) => {
     const { userID, code, message } = item;
     // userID - User ID of the failed query
     // code - Error code of the failed query
     // message - Error message of the failed query
   });
}).catch(function(imError) {
  console.warn('unsubscribeUserStatus error:', imError); // Information related to the unsubscription failure
});

/**
 * Scenarios for receiving notifications:
 * 1. When a subscribed user's status changes (including online status and user-defined status), this event will be triggered
 * 2. If the Friend Status Notification Switch is enabled in the console, even if you haven't actively subscribed, this event will be triggered when a friend's status changes
 * 3. When the same account logs in to multiple devices, if one device modifies the user-defined status, all devices will receive this event
 */
let onUserStatusUpdated = function(event) {
   console.log(event.data);
   const userStatusList = event.data;
   userStatusList.forEach((item) => {
     const { userID, statusType, customStatus } = item;
     // userID - User ID
     // statusType - User status, the enumerated values and descriptions are as follows:
     // TencentCloudChat.TYPES.USER_STATUS_UNKNOWN - Unknown
     // TencentCloudChat.TYPES.USER_STATUS_ONLINE - Online
     // TencentCloudChat.TYPES.USER_STATUS_OFFLINE - Offline
     // TencentCloudChat.TYPES.USER_STATUS_UNLOGINED - Not Logged In
     // customStatus - User Definition Status
   })
};
chat.on(TencentCloudChat.EVENT.USER_STATUS_UPDATED, onUserStatusUpdated);