1. Epic GamesDeveloper
  3. USocialUser

USocialUser

API > API/Plugins > API/Plugins/Party

   
Name USocialUser
Type class
Header File /Engine/Plugins/Online/OnlineFramework/Source/Party/Public/User/SocialUser.h
Include Path #include "User/SocialUser.h"

Syntax

UCLASS (MinimalAPI, Within=SocialToolkit)  
class USocialUser : public UObject

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

USocialUser()

   User/SocialUser.h  

Classes

Name Remarks
FDebugInitializer  
FOnBlockedStatusChanged  
FOnFriendRemoved  
FOnNicknameChanged  
FOnSubsystemIdEstablished  
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
FOnUserPresenceChanged  
FPartyInviteResponseEvent  

Structs

Name Remarks
FSubsystemUserInfo  

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bIsInitialized bool   User/SocialUser.h  
DebugInitializer TUniquePtr< FDebugInitializer >   User/SocialUser.h  
OnBlockedStatusChangedEvent FOnBlockedStatusChanged   User/SocialUser.h  
OnFriendInviteRemovedEvent FOnFriendRemoved   User/SocialUser.h  
OnFriendRemovedEvent FOnFriendRemoved   User/SocialUser.h  
OnPartyInviteAcceptedEvent FPartyInviteResponseEvent   User/SocialUser.h  
OnPartyInviteRejectedEvent FPartyInviteResponseEvent   User/SocialUser.h  
OnSetNicknameCompletedEvent FOnNicknameChanged   User/SocialUser.h  
OnSubsystemIdEstablishedEvent FOnSubsystemIdEstablished   User/SocialUser.h  
OnUserGameSpecificStatusChangedEvent FOnUserGameSpecificStatusChanged   User/SocialUser.h  
OnUserPresenceChangedEvent FOnUserPresenceChanged   User/SocialUser.h  
ReceivedPartyInvites TArray< IOnlinePartyJoinInfoConstRef >   User/SocialUser.h  
SubsystemInfoByType TMap< ESocialSubsystem, FSubsystemUserInfo >   User/SocialUser.h  
UserInitializedEvents TArray< FOnNewSocialUserInitialized > Initialization delegates that fire only when a specific user has finishing initializing. User/SocialUser.h  
USocialToolkit friend   User/SocialUser.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

virtual bool AcceptFriendInvite ( ESocialSubsystem SocialSubsystem
) const

   User/SocialUser.h  

void AcceptRequestToJoinParty()

   User/SocialUser.h  

virtual bool BlockUser ( ESocialSubsystem Subsystem
) const

   User/SocialUser.h  

bool CanInviteToParty ( const FOnlinePartyTypeId& PartyTypeId
) const

   User/SocialUser.h  

virtual bool CanReceiveOfflineInvite()

   User/SocialUser.h  

virtual bool CanRequestToJoin()

   User/SocialUser.h  

virtual bool CanSendFriendInvite ( ESocialSubsystem SubsystemType
) const

   User/SocialUser.h  

FJoinPartyResult CheckPartyJoinability ( const FOnlinePartyTypeId& PartyTypeId,
bool bCheckPlatformSession
) const

   User/SocialUser.h  

void DismissRequestToJoinParty()

   User/SocialUser.h  

virtual bool EndFriendship ( ESocialSubsystem SocialSubsystem
) const

   User/SocialUser.h  

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

   User/SocialUser.h  

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

   User/SocialUser.h  

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

   User/SocialUser.h  

virtual TArray< FSocialInteractionHandle > GetAllAvailableInteractions()

   User/SocialUser.h  

TMap< FString, FString > GetAnalyticsContext()

   User/SocialUser.h  

virtual FUserPlatform GetCurrentPlatform()

   User/SocialUser.h  

virtual int64 GetCustomSortValuePrimary()

   User/SocialUser.h  

virtual int64 GetCustomSortValueSecondary()

   User/SocialUser.h  

virtual int64 GetCustomSortValueTertiary()

   User/SocialUser.h  

FString GetDisplayName ( ESocialSubsystem SubsystemType
) const

   User/SocialUser.h  
  User/SocialUser.h  

EInviteStatus::Type GetFriendInviteStatus ( ESocialSubsystem SubsystemType
) const

   User/SocialUser.h  

const FOnlineUserPresence * GetFriendPresenceInfo ( ESocialSubsystem SubsystemType
) const

   User/SocialUser.h  

UE::Online::TOnlineResult< UE::Online::FGetCachedPresence > GetFriendPresenceInfoV2 ( ESocialSubsystem SubsystemType
) const

   User/SocialUser.h  

FDateTime GetFriendshipCreationDate()

   User/SocialUser.h  

virtual int64 GetInteractionScore()

   User/SocialUser.h  

virtual FDateTime GetLastOnlineDate()

   User/SocialUser.h  

virtual FString GetMarkupTagForPlatform ( const FUserPlatform& RemoteUserPlatform
) const

   User/SocialUser.h  

virtual FString GetNickname()

   User/SocialUser.h  

EOnlinePresenceState::Type GetOnlineStatus()

   User/SocialUser.h  

UE::Online::EUserPresenceStatus GetOnlineStatusV2()

   User/SocialUser.h  

USocialToolkit & GetOwningToolkit()

   User/SocialUser.h  

virtual IOnlinePartyJoinInfoConstPtr GetPartyJoinInfo ( const FOnlinePartyTypeId& PartyTypeId
) const

   User/SocialUser.h  

UPartyMember * GetPartyMember ( const FOnlinePartyTypeId& PartyTypeId
) const

   User/SocialUser.h  

virtual FString GetPlatformIconMarkupTag ( EPlatformIconDisplayRule DisplayRule,
FString& OutLegacyString
) const

   User/SocialUser.h  
  User/SocialUser.h  

TArray< ESocialSubsystem > GetRelationshipSubsystems ( ESocialRelationship Relationship
) const

   User/SocialUser.h  

TArray< ESocialSubsystem > GetRelevantSubsystems()

   User/SocialUser.h  

virtual void GetRichPresenceText ( FText& OutRichPresence
) const

   User/SocialUser.h  

FText GetSocialName()

   User/SocialUser.h  

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

   User/SocialUser.h  

FUniqueNetIdRepl GetUserId ( ESocialSubsystem SubsystemType
) const

   User/SocialUser.h  

void HandlePartyInviteReceived ( const IOnlinePartyJoinInfo& Invite
)

   User/SocialUser.h  

void HandlePartyInviteRemoved ( const IOnlinePartyJoinInfo& Invite,
EPartyInvitationRemovedReason Reason
)

   User/SocialUser.h  

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

   User/SocialUser.h  

virtual void HandlePartyRequestToJoinSent ( const FUniqueNetId& LocalUserId,
const FUniqueNetId& PartyLeaderId,
const FDateTime& ExpiresAt,
const ERequestToJoinPartyCompletionResult Result,
FName JoinMethod,
FString Metadata
)

   User/SocialUser.h  

void HandleRequestToJoinReceived ( const IOnlinePartyRequestToJoinInfo& Request
)

   User/SocialUser.h  

void HandleRequestToJoinRemoved ( const IOnlinePartyRequestToJoinInfo& Request,
EPartyRequestToJoinRemovedReason Reason
)

   User/SocialUser.h  

virtual bool HasAnyInteractionsAvailable()

   User/SocialUser.h  

virtual bool HasBeenInvitedToParty ( const FOnlinePartyTypeId& PartyTypeId
) const

   User/SocialUser.h  

bool HasNetId ( const FUniqueNetIdRepl& UniqueId
) const

   User/SocialUser.h  

virtual bool HasRequestedToJoinUs()

   User/SocialUser.h  

bool HasSentPartyInvite ( const FOnlinePartyTypeId& PartyTypeId
) const

   User/SocialUser.h  

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

   User/SocialUser.h  

bool HasSubsystemInfo ( ESocialSubsystem Subsystem
) const

   User/SocialUser.h  

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

   User/SocialUser.h  

bool IsAnyInboundFriendshipPending()

   User/SocialUser.h  

bool IsBlocked ( ESocialSubsystem SubsystemType
) const

   User/SocialUser.h  

bool IsBlocked ()

   User/SocialUser.h  

bool IsFriend ()

   User/SocialUser.h  

bool IsFriend ( ESocialSubsystem SubsystemType
) const

   User/SocialUser.h  

bool IsFriendshipPending ( ESocialSubsystem SubsystemType
) const

   User/SocialUser.h  

bool IsInitialized()

   User/SocialUser.h  

bool IsLocalUser()

   User/SocialUser.h  

bool IsOnline()

   User/SocialUser.h  

bool IsPlayingThisGame()

   User/SocialUser.h  

bool IsRecentPlayer ( ESocialSubsystem SubsystemType
) const

   User/SocialUser.h  

bool IsRecentPlayer ()

   User/SocialUser.h  

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

   User/SocialUser.h  

USocialUser::FOnBlockedStatusChanged TBaseMulticastDelegate_TwoParams OnBlockedStatusChanged()

   User/SocialUser.h  

FOnFriendRemoved & OnFriendInviteRemoved()

   User/SocialUser.h  

USocialUser::FOnFriendRemoved TBaseMulticastDelegate_OneParam OnFriendRemoved()

   User/SocialUser.h  

FPartyInviteResponseEvent & OnPartyInviteAccepted()

   User/SocialUser.h  

FPartyInviteResponseEvent & OnPartyInviteRejected()

   User/SocialUser.h  

FOnNicknameChanged & OnSetNicknameCompleted()

   User/SocialUser.h  

USocialUser::FOnSubsystemIdEstablished TBaseMulticastDelegate_ThreeParams OnSubsystemIdEstablished()

   User/SocialUser.h  

USocialUser::FOnUserGameSpecificStatusChanged TBaseMulticastDelegate_NoParams OnUserGameSpecificStatusChanged()

   User/SocialUser.h  

USocialUser::FOnUserPresenceChanged TBaseMulticastDelegate_OneParam OnUserPresenceChanged()

   User/SocialUser.h  

virtual void PopulateSortParameterList ( TArray< int64 >& OutSortParams
) const

 Populate list with sort values in order of priority User/SocialUser.h  

void RegisterInitCompleteHandler ( const FOnNewSocialUserInitialized& OnInitializationComplete
)

   User/SocialUser.h  

virtual bool RejectFriendInvite ( ESocialSubsystem SocialSubsystem
) const

   User/SocialUser.h  

virtual void RejectPartyInvite ( const FOnlinePartyTypeId& PartyTypeId
)

   User/SocialUser.h  

virtual void RequestToJoinParty ( const FName& JoinMethod
)

   User/SocialUser.h  

virtual bool SendFriendInvite ( ESocialSubsystem SubsystemType
)

   User/SocialUser.h  

virtual bool SetNickname ( const FString& InNickName
)

   User/SocialUser.h  

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

   User/SocialUser.h  

bool ShowPlatformProfile()

   User/SocialUser.h  

FString ToDebugString()

   User/SocialUser.h  

virtual bool UnblockUser ( ESocialSubsystem Subsystem
) const

   User/SocialUser.h  

void ValidateFriendInfo ( ESocialSubsystem SubsystemType
)

   User/SocialUser.h  

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

   User/SocialUser.h  

Protected

Name Remarks Include Path Unreal Specifiers

void Debug_RandomizePresence()

   User/SocialUser.h  

virtual FString GetRequestToJoinMetadata ( const FString& ExistingMetadata
)

   User/SocialUser.h  

IOnlinePartyJoinInfoConstPtr GetSentPartyInvite ( const FOnlinePartyTypeId& PartyTypeId
) const

   User/SocialUser.h  

const FSubsystemUserInfo * GetSubsystemUserInfo ( ESocialSubsystem Subsystem
) const

   User/SocialUser.h  

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

   User/SocialUser.h  

void Initialize ( const FUniqueNetIdRepl& PrimaryId
)

   User/SocialUser.h  

void InitLocalUser()

   User/SocialUser.h  

void NotifyFriendInviteRemoved ( ESocialSubsystem SubsystemType
)

   User/SocialUser.h  

void NotifyPresenceChanged ( ESocialSubsystem SubsystemType
)

   User/SocialUser.h  

virtual void NotifyRequestToJoinReceived ( const IOnlinePartyRequestToJoinInfo& Request
)

   User/SocialUser.h  

virtual void NotifyRequestToJoinRemoved ( const IOnlinePartyRequestToJoinInfo& Request,
EPartyRequestToJoinRemovedReason Reason
)

   User/SocialUser.h  

void NotifyUserUnblocked ( ESocialSubsystem SubsystemType
)

   User/SocialUser.h  

void NotifyUserUnfriended ( ESocialSubsystem SubsystemType
)

   User/SocialUser.h  

virtual void OnPartyInviteAcceptedInternal ( const FOnlinePartyTypeId& PartyTypeId,
const IOnlinePartyJoinInfo& Invite
) const

   User/SocialUser.h  

virtual void OnPartyInviteAcceptedInternal ( const FOnlinePartyTypeId& PartyTypeId
) const

   User/SocialUser.h  

virtual void OnPartyInviteRejectedInternal ( const FOnlinePartyTypeId& PartyTypeId
) const

   User/SocialUser.h  

virtual void OnPresenceChangedInternal ( ESocialSubsystem SubsystemType
)

   User/SocialUser.h  

virtual void OnPresenceChangedInternalV2 ( ESocialSubsystem SubsystemType
)

   User/SocialUser.h  

virtual void SetSubsystemId ( ESocialSubsystem SubsystemType,
const FUniqueNetIdRepl& SubsystemId
)

   User/SocialUser.h  

virtual TFuture< void > SetupCommonAccount()

 This method should be extended in derived classes to asynchronously set up the correct CommonAccount state for the given social user. User/SocialUser.h  

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

   User/SocialUser.h  

bool ShouldReadUserInfoFromOnlineServices()

   User/SocialUser.h  

void TryBroadcastInitializationComplete()

   User/SocialUser.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page