Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Programming and Scripting > Online Subsystems and Services > Online Services > Online Services Interfaces > User Info Interface

Light Theme

Dark Theme

User Info Interface

Access a player's display name and avatar for use in your game.

API Overview

Functions

The following table provides a high-level overview of the functions provided by the User Info Interface:


Function	Description
User Information
`QueryUserInfo`	Query user info for the list of account IDs.
`GetUserInfo`	Retrieve the user info for the account ID previously cached by `QueryUserInfo`.
User Avatar
`QueryUserAvatar`	Query user avatars for the list of account IDs.
`GetUserAvatar`	Retrieve the user avatar for the account ID previously cached by `QueryUserAvatar`.
Platform UI
`ShowUserProfile`	Show the profile UI for the provided account ID.

Access User Info

Accessing user information with the User Info Interface works similarly to the other Online Services Interfaces.

QueryUserInfo caches the list of user display names associated with their corresponding account ID with the interface. QueryUserInfo requires you to provide the list of user account IDs for which you want to access display names as parameters. To access each user's display name, call GetUserInfo using their account ID.

Access User Avatar

The workflow defined in the Access User Info section applies to accessing a user's avatar as well. QueryUserAvatar caches the information with the interface. GetUserAvatar retrieves each avatar individually.

Platform User Profile

ShowUserProfile brings up the platform service's profile user interface for the provided user. Platform service profiles are specific to the platform on which the user is currently playing your game. Consult your platform service's documentation for more information on the profile user interface.

More Information

Header File

Consult the UserInfo.h header file directly for more information as needed. The User Info Interface header file UserInfo.h is located in the directory:

Engine\Plugins\Online\OnlineServices\Source\OnlineServicesInterface\Public\Online

For instructions on how to obtain the UE source code, see our documentation on Downloading Unreal Engine Source Code.

Function Parameters and Return Types

See the Functions section of the Online Services Overview page for an explanation of function parameters and return types, including how to pass parameters and how to process the results when functions return.