1. Epic GamesDeveloper
  3. IOnlineUser

IOnlineUser

Interface class for obtaining online User info

API > API/Plugins > API/Plugins/OnlineSubsystem > API/Plugins/OnlineSubsystem/Interfaces

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

  Type Name Description
Public variable FOnQueryUserInfoComplete[1] OnQueryUserInfoCompleteDelegates Delegate used when the user query request has completed

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function Virtual FDelegateHandle  
Public function Virtual void  
Public function Virtual void

ClearOnQueryUserInfoCompleteDelegates ( int32 LocalUserNum,
void* Object
)

  
Public function bool

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

 Obtains the cached list of online user info
Public function FUniqueNetIdPtr

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

 Get the cached user id for the specified external id
Public function void

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

 Get the cached user ids for the specified external ids
Public function TSharedPtr< FOnlineUser >

GetUserInfo ( int32 LocalUserNum,
const FUniqueNetId& UserId
)

 Get the cached user entry for a specific user id if found
Public function bool

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

 Contacts server to obtain user ids from external ids
Public function 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
Public function bool

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

 Starts an async task that queries/reads the info for a list of users
Public function Virtual void

TriggerOnQueryUserInfoCompleteDelegates ( int32 LocalUserNum,
bool Param1,
const TArray< FUniqueNetIdRef >& Param2,
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

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page