useUsers for PubNub Chat Components for React

Migrate to Chat SDK

PubNub will stop supporting Chat Components on January 1, 2025 but you are welcome to contribute. Learn how to migrate to the Chat SDK here.

The hook returns a list of User ID metadata objects, optionally including the custom data object for each.

User ID / UUID

User ID is also referred to as UUID/uuid in some APIs and server responses but holds the value of the userId parameter you set during initialization.

Pagination is handled internally. You can adjust the limit of returned users on a single call (max/default 100) and call a function returned by the hook to get another page of results. This hook also sets up a listener that will react to updates and removals of already-fetched users. However, this behavior requires a living subscription to users getting updated - this should be handled by the components.

const [users, fetchPage, total, error, isLoading] = useUsers();

return <Chat users={users}>{/* Add components here */}</Chat>;

Input

Parameter	Type	Required	Defaults	Description
include	Object	Optional	n/a	Option to include respective additional fields in the response.
→ customFields	Boolean	Optional	false	Option to fetch custom fields.
filter	String	Optional	n/a	Expression used to filter the results. Only objects whose properties satisfy the given expression are returned. See the App Context Filtering Language Definition for more details.
sort	Object	Optional	n/a	Key-value pair of a property to sort by and a sort direction. Available options are id, name, and updated. Use asc or desc to specify sort direction, or specify null to take the default sort direction (ascending). Example: {name: 'asc'}
limit	Number	Optional	100	Number of objects to return in response. Default is 100 which is also the maximum value.

Output

Parameter	Type	Description
array[0]	User[]	List of returned users.
array[1]	Function	Function that can be called to fetch another page of users.
array[2]	Number	Total number of stored users.
array[3]	Error	If there's an error fetching users, it will be available here.
array[4]	Boolean	Indicator that the users data is still being loaded.