Roblox UtilitiesDevlHub Roblox Documentation

Class

UserService

NotCreatableService
Inherits
Instance › Object
Memory category
Instances

A service that handles queries regarding users on the Roblox platform.

A service that handles queries regarding users on the Roblox platform.

Methods 2#

GetUserInfosByUserIdsAsyncReturns an array of user information including user name and display name.Yields
GetUserFromGlobalUserIdAsyncReturns a User for the given global user ID within the current experience.Yields

GetUserInfosByUserIdsAsync(userIds: Array): Array#

Yields

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 LuaGlobals.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 Class.Player.UserId|UserId associated with the user.
Username string The username associated with the user.
DisplayName string The Class.Player.DisplayName|DisplayName associated with the user.
HasVerifiedBadge boolean The Class.Player.HasVerifiedBadge|HasVerifiedBadge value associated with the user.
NameTypeDefaultDescription
userIdsArrayAn array of UserIds requested.
Returns
  • Array — An array of dictionary objects that contain user information.

GetUserFromGlobalUserIdAsync(userId: int64): User#

Yields

Resolves a global user ID to a User for the current experience domain. Use this when you have a legacy global user ID (for example, one previously saved in a data store) and need the corresponding User value.

This is a server-only yielding call.

NameTypeDefaultDescription
userIdint64The global user ID to resolve.
Returns
  • User — User: The User representing the resolved domain-scoped identity.

Inherited members#

Inherited from Instance 58
Inherited from Object 6
Properties (2)

ClassName, className

Events (1)

Changed