1. Epic GamesDeveloper
  3. IOnlineUser

IOnlineUser

Interface class for obtaining online User info

API > API/Plugins > API/Plugins/OnlineSubsystem

Interface class for obtaining online User info

   
Name IOnlineUser
Type class
Header File /Engine/Plugins/Online/OnlineSubsystem/Source/Public/Interfaces/OnlineUserInterface.h
Include Path #include "Interfaces/OnlineUserInterface.h"

Syntax

class IOnlineUser

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~IOnlineUser()

   Interfaces/OnlineUserInterface.h  

Typedefs

Name Type Remarks Include Path
FOnQueryExternalIdMappingsComplete TBaseDelegate_FiveParams< void, bool, const FUniqueNetId &, const FExternalIdQueryOptions &, const TArray< FString > &, const FString & > Called when done querying for UserId mappings from external ids Interfaces/OnlineUserInterface.h
FOnQueryUserMappingComplete TBaseDelegate_FiveParams< void, bool, const FUniqueNetId &, const FString &, const FUniqueNetId &, const FString & > Called when done querying for a UserId mapping from a requested display name Interfaces/OnlineUserInterface.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
OnQueryUserInfoCompleteDelegates FOnQueryUserInfoComplete Delegate used when the user query request has completed Interfaces/OnlineUserInterface.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual FDelegateHandle AddOnQueryUserInfoCompleteDelegate_Handle ( int32 LocalUserNum,
const FOnQueryUserInfoCompleteDelegate& Delegate
)

   Interfaces/OnlineUserInterface.h  

virtual void ClearOnQueryUserInfoCompleteDelegate_Handle ( int32 LocalUserNum,
FDelegateHandle& Handle
)

   Interfaces/OnlineUserInterface.h  

virtual void ClearOnQueryUserInfoCompleteDelegates ( int32 LocalUserNum,
FDelegateUserObject Object
)

   Interfaces/OnlineUserInterface.h  

bool GetAllUserInfo ( int32 LocalUserNum,
TArray< TSharedRef< class FOnlineUser > >& OutUsers
)

 Obtains the cached list of online user info Interfaces/OnlineUserInterface.h  

FUniqueNetIdPtr GetExternalIdMapping ( const FExternalIdQueryOptions& QueryOptions,
const FString& ExternalId
)

 Get the cached user id for the specified external id Interfaces/OnlineUserInterface.h  

void GetExternalIdMappings ( const FExternalIdQueryOptions& QueryOptions,
const TArray< FString >& ExternalIds,
TArray< FUniqueNetIdPtr >& OutIds
)

 Get the cached user ids for the specified external ids Interfaces/OnlineUserInterface.h  

TSharedPtr< FOnlineUser > GetUserInfo ( int32 LocalUserNum,
const FUniqueNetId& UserId
)

 Get the cached user entry for a specific user id if found Interfaces/OnlineUserInterface.h  

bool QueryExternalIdMappings ( const FUniqueNetId& UserId,
const FExternalIdQueryOptions& QueryOptions,
const TArray< FString >& ExternalIds,
const FOnQueryExternalIdMappingsComplete& Delegate
)

 Contacts server to obtain user ids from external ids Interfaces/OnlineUserInterface.h  

bool QueryUserIdMapping ( const FUniqueNetId& UserId,
const FString& DisplayNameOrEmail,
const FOnQueryUserMappingComplete& Delegate
)

 Contacts server to obtain a user id from an arbitrary user-entered name string, eg. display name Interfaces/OnlineUserInterface.h  

bool QueryUserInfo ( int32 LocalUserNum,
const TArray< FUniqueNetIdRef >& UserIds
)

 Starts an async task that queries/reads the info for a list of users Interfaces/OnlineUserInterface.h  

virtual void TriggerOnQueryUserInfoCompleteDelegates ( int32 LocalUserNum,
bool Param1,
const TArray< FUniqueNetIdRef >& Param2,
const FString& Param3
)

   Interfaces/OnlineUserInterface.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page