UserService
A service that handles queries regarding users on the Roblox platform.
This class is not creatable. Instances of this class cannot be created with Instance.new.
This class is a service. It is a singleton that may be acquired with GetService.
Memory category | Instances |
---|
Member index 1
Description
A service that handles queries regarding users on the Roblox platform.
History 3
- 462 Change ThreadSafety of GetUserInfosByUserIdsAsync from to Unsafe
- 426 Add GetUserInfosByUserIdsAsync
- 426 Add UserService
Members 1
GetUserInfosByUserIdsAsync
Parameters (1) | ||
---|---|---|
userIds | Array | |
Returns (1) | ||
Array |
This function lets you request information about users outside of the current DataModel in bulk. The input and output values are both arrays.
- The order of the user info objects in the return value's array may not
match the order of the UserIds sent in the input
parameter's array. Use the
Id
field of the user info object to identify your input array with the output array. - It's possible to receive fewer user info objects than requested if one or more of the UserIds in the request array are invalid, such as negative numbers or user IDs that don't have accounts associated with them. It's possible to receive a response with zero results if all UserIds are invalid.
- If a Roblox user does not have a DisplayName
associated with their account, this function will instead return the
same string as the user's username in their info object's
DisplayName
field. While a user's UserId will never change, they may change their username or display name, so the same input UserIds may return a different string for these fields from one day to another. - Since GetUserInfosByUserIdsAsync() makes an external web request, it will yield and may fail if the backend service is experiencing interruptions. Ensure you can handle downtime appropriately by wrapping this method with a pcall().
- Results are limited to 250 per minute, so if you receive an HTTP 429 error, try again later, ideally after reducing the number of UserIds in your input array, reducing the number of method calls, or both.
The signature of a singular user info object is:
Key | Type | Description |
---|---|---|
Id | number | The UserId associated with the user. |
Username | string | The username associated with the user. |
DisplayName | string | The DisplayName associated with the user. |
HasVerifiedBadge | boolean | The HasVerifiedBadge value associated with the user. |
This function yields. It will block the calling thread until completion.
Thread safety | Unsafe |
---|
History 2
- 462 Change ThreadSafety of GetUserInfosByUserIdsAsync from to Unsafe
- 426 Add GetUserInfosByUserIdsAsync