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

> Unreal Engine API Reference > Plugins > OnlineSubsystem > Interfaces > IOnlineUser

Light Theme

Dark Theme

IOnlineUser

Interface class for obtaining online User info

Windows

MacOS

Linux

References

Module	OnlineSubsystem
Header	/Engine/Plugins/Online/OnlineSubsystem/Source/Public/Interfaces/OnlineUserInterface.h
Include	#include "Interfaces/OnlineUserInterface.h"

Syntax

class IOnlineUser

Remarks

Interface class for obtaining online User info

Variables

		Name	Description
	FOnQueryUserInf...	OnQueryUserInfoCompleteDelegates	Delegate used when the user query request has completed

Destructors

	Name	Description
	~IOnlineUser()

Functions

	Name	Description
FDelegateHan...	AddOnQueryUserInfoCompleteDelegate_Handle ( int32 LocalUserNum, const FOnQueryUserInfoCompleteDeleg... )
void	ClearOnQueryUserInfoCompleteDelegate_Handle ( int32 LocalUserNum, FDelegateHandle& Handle )
void	ClearOnQueryUserInfoCompleteDelegates ( int32 LocalUserNum, void* Object )
bool	GetAllUserInfo ( int32 LocalUserNum, TArray< TSharedRef< class FOnlineUs... )	Obtains the cached list of online user info
TSharedPtr< ...	GetExternalIdMapping ( const FExternalIdQueryOptions& Que..., const FString& ExternalId )	Get the cached user id for the specified external id
void	GetExternalIdMappings ( const FExternalIdQueryOptions& Que..., const TArray< FString >& ExternalI..., TArray< TSharedPtr< const FUniqueNe... )	Get the cached user ids for the specified external ids
TSharedPtr< ...	GetUserInfo ( int32 LocalUserNum, const FUniqueNetId& UserId )	Get the cached user entry for a specific user id if found
bool	QueryExternalIdMappings ( const FUniqueNetId& UserId, const FExternalIdQueryOptions& Que..., const TArray< FString >& ExternalI..., const FOnQueryExternalIdMappingsCom... )	Contacts server to obtain user ids from external ids
bool	QueryUserIdMapping ( const FUniqueNetId& UserId, const FString& DisplayNameOrEmail, const FOnQueryUserMappingComplete&... )	Contacts server to obtain a user id from an arbitrary user-entered name string, eg. display name
bool	QueryUserInfo ( int32 LocalUserNum, const TArray< TSharedRef< const FUn... )	Starts an async task that queries/reads the info for a list of users
void	TriggerOnQueryUserInfoCompleteDelegates ( int32 LocalUserNum, bool Param1, const TArray< TSharedRef< const FUn..., const FString& Param3 )

Typedefs

Name	Description
FOnQueryExternalIdMappingsComplete	Called when done querying for UserId mappings from external ids
FOnQueryUserMappingComplete	Called when done querying for a UserId mapping from a requested display name

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss