Retrieve Users

Learn how to retrieve a list of users.

Retrieve Logged In User Details

You can get the details of the logged-in user using the getLoggedInUser() method. This method can also be used to check if the user is logged in or not.
If the method returns Promise with reject callback, it indicates that the user is not logged in and you need to log the user into CometChat SDK.

var user = CometChat.getLoggedinUser().then(
  user => {
    console.log("user details:", { user });
  },
  error => {
    console.log("error getting details:", { error });
  }
);

This method will return a User object containing all the information related to the logged-in user.

Retrieve List of Users

In order to fetch the list of users, you can use the UsersRequest class. To use this class i.e to create an object of the UsersRequest class, you need to use the UsersRequestBuilder class. The UsersRequestBuilder class allows you to set the parameters based on which the users are to be fetched.

The UsersRequestBuilder class allows you to set the below parameters:

  1. setLimit(limit: number) - This method sets the limit i.e. the number of users that should be fetched in a single iteration.

let usersRequest = new CometChat.UsersRequestBuilder().setLimit(30).build();

  1. setSearchKeyword(searchString: string ) - This method allows you to set the search string based on which the users are to be fetched.

let usersRequest = new CometChat.UsersRequestBuilder()
  .setLimit(limit)
  .setSearchKeyword("abc")
  .build();


  1. setStatus(status: string) - The status based on which the users are to be fetched. The status parameter can contain one of the below two values:
    a. CometChat.USER_STATUS.ONLINE - will return the list of only online users.
    b. CometChat.USER_STATUS.OFFLINE - will return the list of only offline users.
    If this parameter is not set, will return all the available users.

let usersRequest = new CometChat.UsersRequestBuilder()
  .setLimit(limit)
  .setStatus(CometChat.USER_STATUS.ONLINE)
  .build()

  1. hideBlockedUsers(hideBlockedUsers: boolean) - This method is used to determine if the blocked users should be returned as a part of the user list. if set to true, the user list will not contain the users blocked by the logged in user.

let usersRequest = new CometChat.UsersRequestBuilder()
  .setLimit(limit)
  .hideBlockedUsers(true)
  .build();


  1. setRole(role: string) - This method when set will only return the users that belong to the roles specified.

let role = "default";
let usersRequest = new CometChat.UsersRequestBuilder()
  .setLimit(limit)
  .setRole(role)
  .build();

❗️

Important

Please note that setRole() has been deprecated starting version 2.0.13. Please use setRoles() instead.

  1. setRoles(roles: Array<String>) - This method allows you to fetch the users based on multiple roles.

let roles = ["default", "dev"];
let usersRequest = new CometChat.UsersRequestBuilder()
  .setLimit(limit)
  .setRoles(roles)
  .build();
  1. friendsOnly(friendsOnly: boolean) - This property when set to true will return only the friends of the logged-in user.

let usersRequest = new CometChat.UsersRequestBuilder()
  .setLimit(limit)
  .friendsOnly(true)
  .build();
  1. setTags(tags: Array<String>) - This method accepts a list of tags based on which the list of users is to be fetched. The list fetched will only contain the users that have been tagged with the specified tags.

let tags = ["tag1", "tag2"];
let usersRequest = new CometChat.UsersRequestBuilder()
  .setLimit(limit)
  .setTags(tags)
  .build();
  1. withTags(withTags: boolean) - This property when set to true will fetch tags data along with the list of users.

let usersRequest = new CometChat.UsersRequestBuilder()
  .setLimit(limit)
  .withTags(true)
  .build();
  1. setUIDs(UIDs: Array<String>) - This method accepts a list of UIDs based on which the list of users is fetched. A maximum of 25 users can be fetched.

let UIDs = ["superhero1", "superhero2"];
let usersRequest = new CometChat.UsersRequestBuilder()
  .setLimit(limit)
  .setUIDs(UIDs)
  .build();

Finally, once all the parameters are set to the builder class, you need to call the build() method to get the object of the UsersRequest class.

Once you have the object of the UsersRequest class, you need to call the fetchNext() method. Calling this method will return a list of User objects containing n number of users where n is the limit set in the builder class.

var limit = 30;
var usersRequest = new CometChat.UsersRequestBuilder().setLimit(limit).build();

usersRequest.fetchNext().then(
  userList => {
    /* userList will be the list of User class. */
    console.log("User list received:", userList);
    /* retrived list can be used to display contact list. */
  },
  error => {
    console.log("User list fetching failed with error:", error);
  }
);

Retrieve Particular User Details

To get the information of a user, you can use the getUser() method.

var UID = "UID";
CometChat.getUser(UID).then(
  user => {
    console.log("User details fetched for user:", user);
  },
  error => {
    console.log("User details fetching failed with error:", error);
  }
);

The getUser() method takes the following parameters:

Parameter

Description

UID

The UID of the user for whom the details are to be fetched

It returns the User object containing the details of the user.

Get online user count

To get the total count of online users for your app, you can use the getOnlineUserCount() method.

CometChat.getOnlineUserCount().then(
  userCount => {
    console.log("Total online user count:", userCount);
  },
  error => {
    console.log("Online user count fetching failed with error:", error);
  }
);

This method returns the total online user count for your app.


Did this page help you?