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 > Party > User > USocialUser

Light Theme

Dark Theme

USocialUser

Windows

MacOS

Linux

Inheritance Hierarchy

UObjectBase

UObjectBaseUtility

UObject

USocialUser

References

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

Syntax

[UCLASS](Programming/UnrealArchitecture/Reference/Classes#classdeclaration)(Within=SocialToolkit)
class USocialUser : public UObject

Variables

		Name	Description
	bool	bDebug_IsPresenceArtificial
	EOnlinePresence...	Debug_RandomPresence
	int32	NumPendingQueries
	USocialUser::FS...	OnSubsystemIdEstablished

Constructors

	Name	Description
	USocialUser()

Functions

		Name	Description
	bool	AcceptFriendInvite ( ESocialSubsystem SocialSubsystem )
	bool	BlockUser ( ESocialSubsystem Subsystem )
	bool	CanInviteToParty ( const FOnlinePartyTypeId& PartyTyp... )
	bool	CanReceiveOfflineInvite()
	bool	CanSendFriendInvite ( ESocialSubsystem SubsystemType )
	FJoinPartyRe...	CheckPartyJoinability ( const FOnlinePartyTypeId& PartyTyp... )
	void	Debug_RandomizePresence()
	bool	EndFriendship ( ESocialSubsystem SocialSubsystem )
	void	EstablishOssInfo ( const TSharedRef< FOnlineRecentPlay..., ESocialSubsystem SubsystemType )
	void	EstablishOssInfo ( const TSharedRef< FOnlineBlockedPla..., ESocialSubsystem SubsystemType )
	void	EstablishOssInfo ( const TSharedRef< FOnlineFriend >&..., ESocialSubsystem SubsystemType )
	TArray< FSoc...	GetAllAvailableInteractions()
	FUserPlatfor...	GetCurrentPlatform()
	int64	GetCustomSortValuePrimary()
	int64	GetCustomSortValueSecondary()
	FString	GetDisplayName ( ESocialSubsystem SubsystemType )
	FString	GetDisplayName()
	EInviteStatu...	GetFriendInviteStatus ( ESocialSubsystem SubsystemType )
	const FOnlin...	GetFriendPresenceInfo ( ESocialSubsystem SubsystemType )
	FDateTime	GetFriendshipCreationDate()
	FDateTime	GetLastOnlineDate()
	FString	GetMarkupTagForPlatform ( const FUserPlatform& RemoteUserPla... )
	FString	GetNickname()
	EOnlinePrese...	GetOnlineStatus()
	USocialToolk...	GetOwningToolkit()
	IOnlineParty...	GetPartyJoinInfo ( const FOnlinePartyTypeId& PartyTyp... )
	UPartyMember...	GetPartyMember ( const FOnlinePartyTypeId& PartyTyp... )
	FString	GetPlatformIconMarkupTag ( EPlatformIconDisplayRule DisplayRul... )
	FString	GetPlatformIconMarkupTag ( EPlatformIconDisplayRule DisplayRul..., FString& OutLegacyString )
	TArray< ESoc...	GetRelationshipSubsystems ( ESocialRelationship Relationship )
	TArray< ESoc...	GetRelevantSubsystems()
	void	GetRichPresenceText ( FText& OutRichPresence )
	FText	GetSocialName()
	const FSubsy...	GetSubsystemUserInfo ( ESocialSubsystem Subsystem )
	bool	GetUserAttribute ( ESocialSubsystem SubsystemType, const FString& AttrName, FString& OutAttrValue )
	FUniqueNetId...	GetUserId ( ESocialSubsystem SubsystemType )
	void	HandlePartyInviteReceived ( const IOnlinePartyJoinInfo& Invite )
	void	HandlePartyInviteRemoved ( const IOnlinePartyJoinInfo& Invite, EPartyInvitationRemovedReason Reaso... )
	void	HandleSetNicknameComplete ( int32 LocalUserNum, const FUniqueNetId& FriendId, const FString& ListName, const FOnlineError& Error )
	bool	HasAnyInteractionsAvailable()
	bool	HasBeenInvitedToParty ( const FOnlinePartyTypeId& PartyTyp... )
	bool	HasNetId ( const FUniqueNetIdRepl& UniqueId )
	bool	HasSentPartyInvite ( const FOnlinePartyTypeId& PartyTyp... )
	bool	HasSubsystemInfo ( ESocialSubsystem Subsystem )
	bool	HasSubsystemInfo ( const TSet< ESocialSubsystem >& Su..., bool bRequireAll )
	void	Initialize ( const FUniqueNetIdRepl& PrimaryId )
	void	InitLocalUser()
	bool	InviteToParty ( const FOnlinePartyTypeId& PartyTyp... )
	bool	IsBlocked()
	bool	IsBlocked ( ESocialSubsystem SubsystemType )
	bool	IsFriend ( ESocialSubsystem SubsystemType )
	bool	IsFriend()
	bool	IsFriendshipPending ( ESocialSubsystem SubsystemType )
	bool	IsInitialized()
	bool	IsLocalUser()
	bool	IsOnline()
	bool	IsPlayingThisGame()
	bool	IsRecentPlayer ( ESocialSubsystem SubsystemType )
	bool	IsRecentPlayer()
	void	JoinParty ( const FOnlinePartyTypeId& PartyTyp... )
	void	NotifyFriendInviteRemoved ( ESocialSubsystem SubsystemType )
	void	NotifyPresenceChanged ( ESocialSubsystem SubsystemType )
	void	NotifyUserUnblocked ( ESocialSubsystem SubsystemType )
	void	NotifyUserUnfriended ( ESocialSubsystem SubsystemType )
	USocialUser:...	OnBlockedStatusChanged()
	FOnFriendRem...	OnFriendInviteRemoved()
	USocialUser:...	OnFriendRemoved()
	FPartyInvite...	OnPartyInviteAccepted()
	void	OnPartyInviteAcceptedInternal ( const FOnlinePartyTypeId& PartyTyp... )
	FPartyInvite...	OnPartyInviteRejected()
	void	OnPartyInviteRejectedInternal ( const FOnlinePartyTypeId& PartyTyp... )
	void	OnPresenceChangedInternal ( ESocialSubsystem SubsystemType )
	FOnNicknameC...	OnSetNicknameCompleted()
	USocialUser:...	OnSubsystemIdEstablished()
	USocialUser:...	OnUserGameSpecificStatusChanged()
	USocialUser:...	OnUserPresenceChanged()
	void	RegisterInitCompleteHandler ( const FOnNewSocialUserInitialized&... )
	bool	RejectFriendInvite ( ESocialSubsystem SocialSubsystem )
	void	RejectPartyInvite ( const FOnlinePartyTypeId& PartyTyp... )
	bool	SendFriendInvite ( ESocialSubsystem SubsystemType )
	bool	SetNickname ( const FString& InNickName )
	void	SetSubsystemId ( ESocialSubsystem SubsystemType, const FUniqueNetIdRepl& SubsystemI... )
	bool	SetUserLocalAttribute ( ESocialSubsystem SubsystemType, const FString& AttrName, const FString& AttrValue )
	bool	ShowPlatformProfile()
	FString	ToDebugString()
	void	TryBroadcastInitializationComplete()
	bool	UnblockUser ( ESocialSubsystem Subsystem )
	void	ValidateFriendInfo ( ESocialSubsystem SubsystemType )

Classes

	Name	Description
	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
	FSubsystemUserInfo

Constants

Name	Description
InitEventsByUser	Initialization delegates that fire only when a specific user has finishing initializing.

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

Take our survey

Dismiss