1. Epic GamesDeveloper
  3. USocialUser

USocialUser

API > API/Plugins > API/Plugins/Party > API/Plugins/Party/User

Inheritance Hierarchy

References

   
Module Party
Header /Engine/Plugins/Online/OnlineFramework/Source/Party/Public/User/SocialUser.h
Include #include "User/SocialUser.h"

Syntax

UCLASS&40;Within&61;SocialToolkit&41;  
class USocialUser : public UObject

Variables

  Type Name Description
Protected variable TMap< FString, FString > AnalyticsContext  
Protected variable bool bDebug_IsPresenceArtificial  
Protected variable EOnlinePresenceState::Type Debug_RandomPresence  
Protected variable int32 NumPendingQueries  
Protected variable USocialUser::FSubsystemUserInfo & OnSubsystemIdEstablished  

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Public function Virtual Const bool

AcceptFriendInvite ( ESocialSubsystem SocialSubsystem
)

  
Public function Const void  
Public function Virtual Const bool

BlockUser ( ESocialSubsystem Subsystem
)

  
Public function Const bool

CanInviteToParty ( const FOnlinePartyTypeId& PartyTypeId
)

  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Virtual Const bool  
Public function Const FJoinPartyResult

CheckPartyJoinability ( const FOnlinePartyTypeId& PartyTypeId
)

  
Protected function void  
Public function Const void  
Public function Virtual Const bool

EndFriendship ( ESocialSubsystem SocialSubsystem
)

  
Public function void

EstablishOssInfo ( const TSharedRef< FOnlineRecentPlayer >& RecentPlayerInfo,
ESocialSubsystem SubsystemType
)

  
Public function void

EstablishOssInfo ( const TSharedRef< FOnlineBlockedPlayer >& BlockedPlayerInfo,
ESocialSubsystem SubsystemType
)

  
Public function void

EstablishOssInfo ( const TSharedRef< FOnlineFriend >& FriendInfo,
ESocialSubsystem SubsystemType
)

  
Public function Virtual Const TArray< FSocialInteractionHandle >  
Public function Const TMap< FString, FString >  
Public function Virtual Const FUserPlatform  
Public function Virtual Const int64  
Public function Virtual Const int64  
Public function Virtual Const int64  
Public function Const FString

GetDisplayName ( ESocialSubsystem SubsystemType
)

  
Public function Const FString  
Public function Const EInviteStatus::Type  
Public function Const const FOnlineUserPresence *  
Public function Const FDateTime  
Public function Virtual Const int64  
Public function Virtual Const FDateTime  
Public function Virtual Const FString

GetMarkupTagForPlatform ( const FUserPlatform& RemoteUserPlatform
)

  
Public function Virtual Const FString  
Public function Const EOnlinePresenceState::Type  
Public function Const USocialToolkit &  
Public function Virtual Const IOnlinePartyJoinInfoConstPtr

GetPartyJoinInfo ( const FOnlinePartyTypeId& PartyTypeId
)

  
Public function Const UPartyMember *

GetPartyMember ( const FOnlinePartyTypeId& PartyTypeId
)

  
Public function Virtual Const FString

GetPlatformIconMarkupTag ( EPlatformIconDisplayRule DisplayRule,
FString& OutLegacyString
)

  
Public function Const FString  
Public function Const TArray< ESocialSubsystem >  
Public function Const TArray< ESocialSubsystem >  
Public function Virtual Const void

GetRichPresenceText ( FText& OutRichPresence
)

  
Public function Const FText  
Protected function Const const FSubsystemUserInfo *  
Public function Const bool

GetUserAttribute ( ESocialSubsystem SubsystemType,
const FString& AttrName,
FString& OutAttrValue
)

  
Public function Const FUniqueNetIdRepl

GetUserId ( ESocialSubsystem SubsystemType
)

  
Public function void  
Public function void  
Public function Virtual void

HandlePartyRequestToJoinSent ( const FUniqueNetId& LocalUserId,
const FUniqueNetId& PartyLeaderId,
const FDateTime& ExpiresAt,
const ERequestToJoinPartyCompletionResult Result,
FName JoinMethod
)

  
Public function void  
Public function void  
Protected function Virtual void

HandleSetNicknameComplete ( int32 LocalUserNum,
const FUniqueNetId& FriendId,
const FString& ListName,
const FOnlineError& Error
)

  
Public function Virtual Const bool  
Public function Const bool

HasBeenInvitedToParty ( const FOnlinePartyTypeId& PartyTypeId
)

  
Public function Const bool

HasNetId ( const FUniqueNetIdRepl& UniqueId
)

  
Public function Virtual Const bool  
Public function Const bool

HasSentPartyInvite ( const FOnlinePartyTypeId& PartyTypeId
)

  
Public function bool

HasSubsystemInfo ( const TSet< ESocialSubsystem >& SubsystemTypes,
bool bRequireAll
)

  
Public function Const bool  
Protected function void

Initialize ( const FUniqueNetIdRepl& PrimaryId
)

  
Protected function void  
Public function Const bool

InviteToParty ( const FOnlinePartyTypeId& PartyTypeId,
const ESocialPartyInviteMethod InviteMethod,
const FString& MetaData
)

  
Public function Const bool  
Public function Const bool

IsBlocked ( ESocialSubsystem SubsystemType
)

  
Public function Const bool  
Public function Const bool  
Public function Const bool

IsFriend ( ESocialSubsystem SubsystemType
)

  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool  
Public function Const bool

IsRecentPlayer ( ESocialSubsystem SubsystemType
)

  
Public function Const bool  
Public function Virtual Const void

JoinParty ( const FOnlinePartyTypeId& PartyTypeId,
const FName& JoinMethod
)

  
Protected function void  
Protected function void  
Protected function Virtual void  
Protected function Virtual void  
Protected function void  
Protected function void  
Public function Const USocialUser::FOnBlockedStatusChanged TBaseMulticastDelegate_TwoParams  
Public function Const FOnFriendRemoved &  
Public function Const USocialUser::FOnFriendRemoved TBaseMulticastDelegate_OneParam  
Public function Const FPartyInviteResponseEvent &  
Protected function Virtual Const void  
Public function Const FPartyInviteResponseEvent &  
Protected function Virtual Const void  
Protected function Virtual void  
Public function Const FOnNicknameChanged &  
Public function Const USocialUser::FOnSubsystemIdEstablished TBaseMulticastDelegate_ThreeParams  
Public function Const USocialUser::FOnUserGameSpecificStatusChanged TBaseMulticastDelegate_NoParams  
Public function Const USocialUser::FOnUserPresenceChanged TBaseMulticastDelegate_OneParam  
Public function Virtual Const void

PopulateSortParameterList ( TArray< int64 >& OutSortParams
)

 Populate list with sort values in order of priority
Public function void

RegisterInitCompleteHandler ( const FOnNewSocialUserInitialized& OnInitializationComplete
)

  
Public function Virtual Const bool

RejectFriendInvite ( ESocialSubsystem SocialSubsystem
)

  
Public function Virtual void

RejectPartyInvite ( const FOnlinePartyTypeId& PartyTypeId
)

  
Public function Virtual void

RequestToJoinParty ( const FName& JoinMethod
)

  
Public function Virtual bool  
Public function Virtual bool

SetNickname ( const FString& InNickName
)

  
Protected function Virtual void

SetSubsystemId ( ESocialSubsystem SubsystemType,
const FUniqueNetIdRepl& SubsystemId
)

  
Protected function void

SetUserInfo ( ESocialSubsystem SubsystemType,
const TSharedRef< FOnlineUser >& UserInfo
)

  
Public function bool

SetUserLocalAttribute ( ESocialSubsystem SubsystemType,
const FString& AttrName,
const FString& AttrValue
)

  
Public function bool  
Public function Const FString  
Protected function void  
Public function Virtual Const bool  
Public function void  
Public function void

WithContext ( const TMap< FString, FString >& InAnalyticsContext,
void(*)(USocialUser&) Func
)

  

Classes

  Type Name Description
Public class FOnBlockedStatusChanged    
Public class FOnFriendRemoved    
Public class FOnNicknameChanged    
Public class FOnSubsystemIdEstablished    
Public class FOnUserGameSpecificStatusChanged Provided so that lists with custom game-specific filtering (and any other listeners) can potentially re-evaluate a user the pattern here is similar to OnUserPresenceChanged but not subsystem-specific  
Public class FOnUserPresenceChanged    
Public class FPartyInviteResponseEvent    
Protected struct FSubsystemUserInfo    

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page