Users

Manage users and build contact lists in your chat application

Quick Reference for AI Agents & Developers

// Get current user
const user = await CometChat.getLoggedinUser();

// Fetch users list
const usersRequest = new CometChat.UsersRequestBuilder()
  .setLimit(30)
  .build();
const users = await usersRequest.fetchNext();

// Get specific user
const user = await CometChat.getUser("user_uid");

// Search users
const usersRequest = new CometChat.UsersRequestBuilder()
  .setSearchKeyword("john")
  .build();

// Filter online users
const usersRequest = new CometChat.UsersRequestBuilder()
  .setStatus(CometChat.USER_STATUS.ONLINE)
  .build();

// Listen for presence changes
CometChat.addUserListener("LISTENER_ID", new CometChat.UserListener({
  onUserOnline: (user) => console.log(user.getName(), "online"),
  onUserOffline: (user) => console.log(user.getName(), "offline")
}));

Users are the foundation of your chat application. This section covers retrieving, creating, updating, and managing users.

Available via: SDK | REST API | UI Kits

---

Core Concepts

• UID: Unique identifier for each user (typically matches your database user ID)
• User Object: Contains profile info like name, avatar, status, and metadata
• Presence: Real-time online/offline status

---

Quick Start

Get Current User

JavaScript

CometChat.getLoggedinUser().then(
  (user) => {
    if (user) {
      console.log("Logged in as:", user.getName());
    }
  }
);

Async/Await

async function getCurrentUser() {
  try {
    const user = await CometChat.getLoggedinUser();
    if (user) {
      console.log("Logged in as:", user.getName());
    }
    return user;
  } catch (error) {
    console.log("Error:", error);
    throw error;
  }
}

Fetch Users

JavaScript

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

usersRequest.fetchNext().then(
  (users) => console.log("Users:", users),
  (error) => console.log("Error:", error)
);

Async/Await

async function fetchUsers() {
  const usersRequest = new CometChat.UsersRequestBuilder()
    .setLimit(30)
    .build();

  try {
    const users = await usersRequest.fetchNext();
    console.log("Users:", users);
    return users;
  } catch (error) {
    console.log("Error:", error);
    throw error;
  }
}

---

User Management

Retrieve Users

Fetch user lists with filtering and search

User Management

Create, update, and manage user profiles

Block Users

Block and unblock users

User Presence

Track online/offline status in real-time

---

User Object Properties

Property	Method	Description	Editable
UID	getUid()	Unique identifier	No (set at creation)
Name	getName()	Display name	Yes
Avatar	getAvatar()	Profile picture URL	Yes
Status	getStatus()	online or offline	No (system managed)
Role	getRole()	User role for access control	Yes
Metadata	getMetadata()	Custom JSON data	Yes
Status Message	getStatusMessage()	Custom status text	Yes
Last Active	getLastActiveAt()	Last activity timestamp	No
Link	getLink()	Profile page URL	Yes
Tags	getTags()	Array of tags	Yes
Blocked By Me	getBlockedByMe()	If logged-in user blocked them	No
Has Blocked Me	getHasBlockedMe()	If they blocked logged-in user	No

---

Common Use Cases

Build a Contacts List

JavaScript

const usersRequest = new CometChat.UsersRequestBuilder()
  .setLimit(30)
  .friendsOnly(true)
  .build();

usersRequest.fetchNext().then((users) => {
  users.forEach((user) => {
    console.log(user.getName(), user.getStatus());
  });
});

Async/Await

async function fetchContacts() {
  const usersRequest = new CometChat.UsersRequestBuilder()
    .setLimit(30)
    .friendsOnly(true)
    .build();

  try {
    const users = await usersRequest.fetchNext();
    users.forEach((user) => {
      console.log(user.getName(), user.getStatus());
    });
    return users;
  } catch (error) {
    console.log("Error:", error);
    throw error;
  }
}

Search Users

JavaScript

const usersRequest = new CometChat.UsersRequestBuilder()
  .setLimit(30)
  .setSearchKeyword("john")
  .build();

usersRequest.fetchNext().then((users) => {
  console.log("Search results:", users);
});

Async/Await

async function searchUsers(keyword) {
  const usersRequest = new CometChat.UsersRequestBuilder()
    .setLimit(30)
    .setSearchKeyword(keyword)
    .build();

  try {
    const users = await usersRequest.fetchNext();
    console.log("Search results:", users);
    return users;
  } catch (error) {
    console.log("Error:", error);
    throw error;
  }
}

Filter Online Users

JavaScript

const usersRequest = new CometChat.UsersRequestBuilder()
  .setLimit(30)
  .setStatus(CometChat.USER_STATUS.ONLINE)
  .build();

usersRequest.fetchNext().then((users) => {
  console.log("Online users:", users);
});

Async/Await

async function fetchOnlineUsers() {
  const usersRequest = new CometChat.UsersRequestBuilder()
    .setLimit(30)
    .setStatus(CometChat.USER_STATUS.ONLINE)
    .build();

  try {
    const users = await usersRequest.fetchNext();
    console.log("Online users:", users);
    return users;
  } catch (error) {
    console.log("Error:", error);
    throw error;
  }
}

Filter by Role

JavaScript

const usersRequest = new CometChat.UsersRequestBuilder()
  .setLimit(30)
  .setRoles(["premium", "moderator"])
  .build();

usersRequest.fetchNext().then((users) => {
  console.log("Premium/Moderator users:", users);
});

Async/Await

async function fetchUsersByRole(roles) {
  const usersRequest = new CometChat.UsersRequestBuilder()
    .setLimit(30)
    .setRoles(roles)
    .build();

  try {
    const users = await usersRequest.fetchNext();
    console.log("Filtered users:", users);
    return users;
  } catch (error) {
    console.log("Error:", error);
    throw error;
  }
}

---

Real-Time User Events

Listen for user status changes:

const listenerID = "USER_LISTENER";

CometChat.addUserListener(
  listenerID,
  new CometChat.UserListener({
    onUserOnline: (onlineUser) => {
      console.log("User online:", onlineUser.getName());
    },
    onUserOffline: (offlineUser) => {
      console.log("User offline:", offlineUser.getName());
    }
  })
);

// Remove when done
CometChat.removeUserListener(listenerID);

---

Next Steps

Retrieve Users

Learn all filtering and pagination options

User Presence

Implement real-time online/offline status