USocialUser

Choose your operating system:

Windows

macOS

Linux

Inheritance Hierarchy

References

Module

Party

Header

/Engine/Plugins/Online/OnlineFramework/Source/Party/Public/User/SocialUser.h

Include

#include "User/SocialUser.h"

Syntax

UCLASS(Within=SocialToolkit)
class USocialUser : public UObject

Variables

Name Description

Protected variable

TMap< FString, ...

 

AnalyticsContext

Protected variable

bool

 

bDebug_IsPresenceArtificial

Protected variable

EOnlinePresence...

 

Debug_RandomPresence

Protected variable

int32

 

NumPendingQueries

Protected variable

USocialUser::FS...

 

OnSubsystemIdEstablished

Constructors

Name Description

Public function

USocialUser()

Functions

Name Description

Public function Virtual Const

bool

 

AcceptFriendInvite

(
    ESocialSubsystem SocialSubsystem
)

Public function Const

void

 

AcceptRequestToJoinParty()

Public function Virtual Const

bool

 

BlockUser

(
    ESocialSubsystem Subsystem
)

Public function Const

bool

 

CanInviteToParty

(
    const FOnlinePartyTypeId& PartyTyp...
)

Public function Virtual Const

bool

 

CanReceiveOfflineInvite()

Public function Virtual Const

bool

 

CanRequestToJoin()

Public function Virtual Const

bool

 

CanSendFriendInvite

(
    ESocialSubsystem SubsystemType
)

Public function Const

FJoinPartyRe...

 

CheckPartyJoinability

(
    const FOnlinePartyTypeId& PartyTyp...
)

Protected function

void

 

Debug_RandomizePresence()

Public function Const

void

 

DismissRequestToJoinParty()

Public function Virtual Const

bool

 

EndFriendship

(
    ESocialSubsystem SocialSubsystem
)

Public function

void

 

EstablishOssInfo

(
    const TSharedRef< FOnlineRecentPlay...,
    ESocialSubsystem SubsystemType
)

Public function

void

 

EstablishOssInfo

(
    const TSharedRef< FOnlineBlockedPla...,
    ESocialSubsystem SubsystemType
)

Public function

void

 

EstablishOssInfo

(
    const TSharedRef< FOnlineFriend >&...,
    ESocialSubsystem SubsystemType
)

Public function Const

TArray< FSoc...

 

GetAllAvailableInteractions()

Public function Const

TMap< FStrin...

 

GetAnalyticsContext()

Public function Virtual Const

FUserPlatfor...

 

GetCurrentPlatform()

Public function Virtual Const

int64

 

GetCustomSortValuePrimary()

Public function Virtual Const

int64

 

GetCustomSortValueSecondary()

Public function Virtual Const

int64

 

GetCustomSortValueTertiary()

Public function Const

FString

 

GetDisplayName

(
    ESocialSubsystem SubsystemType
)

Public function Const

FString

 

GetDisplayName()

Public function Const

EInviteStatu...

 

GetFriendInviteStatus

(
    ESocialSubsystem SubsystemType
)

Public function Const

const FOnlin...

 

GetFriendPresenceInfo

(
    ESocialSubsystem SubsystemType
)

Public function Const

FDateTime

 

GetFriendshipCreationDate()

Public function Virtual Const

int64

 

GetInteractionScore()

Public function Virtual Const

FDateTime

 

GetLastOnlineDate()

Public function Virtual Const

FString

 

GetMarkupTagForPlatform

(
    const FUserPlatform& RemoteUserPla...
)

Public function Virtual Const

FString

 

GetNickname()

Public function Const

EOnlinePrese...

 

GetOnlineStatus()

Public function Const

USocialToolk...

 

GetOwningToolkit()

Public function Virtual Const

IOnlineParty...

 

GetPartyJoinInfo

(
    const FOnlinePartyTypeId& PartyTyp...
)

Public function Const

UPartyMember...

 

GetPartyMember

(
    const FOnlinePartyTypeId& PartyTyp...
)

Public function Virtual Const

FString

 

GetPlatformIconMarkupTag

(
    EPlatformIconDisplayRule DisplayRul...,
    FString& OutLegacyString
)

Public function Const

FString

 

GetPlatformIconMarkupTag

(
    EPlatformIconDisplayRule DisplayRul...
)

Public function Const

TArray< ESoc...

 

GetRelationshipSubsystems

(
    ESocialRelationship Relationship
)

Public function Const

TArray< ESoc...

 

GetRelevantSubsystems()

Public function Virtual Const

void

 

GetRichPresenceText

(
    FText& OutRichPresence
)

Public function Const

FText

 

GetSocialName()

Protected function Const

const FSubsy...

 

GetSubsystemUserInfo

(
    ESocialSubsystem Subsystem
)

Public function Const

bool

 

GetUserAttribute

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

Public function Const

FUniqueNetId...

 

GetUserId

(
    ESocialSubsystem SubsystemType
)

Public function

void

 

HandlePartyInviteReceived

(
    const IOnlinePartyJoinInfo& Invite
)

Public function

void

 

HandlePartyInviteRemoved

(
    const IOnlinePartyJoinInfo& Invite,
    EPartyInvitationRemovedReason Reaso...
)

Public function

void

 

HandleRequestToJoinReceived

(
    const IOnlinePartyRequestToJoinInfo...
)

Public function

void

 

HandleRequestToJoinRemoved

Public function

void

 

HandleRequestToJoinSent

(
    const FDateTime& ExpiresAt
)

Protected function Virtual

void

 

HandleSetNicknameComplete

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

Public function Const

bool

 

HasAnyInteractionsAvailable()

Public function Const

bool

 

HasBeenInvitedToParty

(
    const FOnlinePartyTypeId& PartyTyp...
)

Public function Const

bool

 

HasNetId

(
    const FUniqueNetIdRepl& UniqueId
)

Public function Virtual Const

bool

 

HasRequestedToJoinUs()

Public function Const

bool

 

HasSentPartyInvite

(
    const FOnlinePartyTypeId& PartyTyp...
)

Public function

bool

 

HasSubsystemInfo

(
    const TSet< ESocialSubsystem >& Su...,
    bool bRequireAll
)

Public function Const

bool

 

HasSubsystemInfo

(
    ESocialSubsystem Subsystem
)

Protected function

void

 

Initialize

(
    const FUniqueNetIdRepl& PrimaryId
)

Protected function

void

 

InitLocalUser()

Public function Const

bool

 

InviteToParty

(
    const FOnlinePartyTypeId& PartyTyp...,
    const ESocialPartyInviteMethod Invi...
)

Public function Const

bool

 

IsBlocked

(
    ESocialSubsystem SubsystemType
)

Public function Const

bool

 

IsBlocked()

Public function Const

bool

 

IsFriend()

Public function Const

bool

 

IsFriend

(
    ESocialSubsystem SubsystemType
)

Public function Const

bool

 

IsFriendshipPending

(
    ESocialSubsystem SubsystemType
)

Public function Const

bool

 

IsInitialized()

Public function Const

bool

 

IsLocalUser()

Public function Const

bool

 

IsOnline()

Public function Const

bool

 

IsPlayingThisGame()

Public function Const

bool

 

IsRecentPlayer

(
    ESocialSubsystem SubsystemType
)

Public function Const

bool

 

IsRecentPlayer()

Public function Const

void

 

JoinParty

(
    const FOnlinePartyTypeId& PartyTyp...
)

Protected function

void

 

NotifyFriendInviteRemoved

(
    ESocialSubsystem SubsystemType
)

Protected function

void

 

NotifyPresenceChanged

(
    ESocialSubsystem SubsystemType
)

Protected function Virtual

void

 

NotifyRequestToJoinReceived

(
    const IOnlinePartyRequestToJoinInfo...
)

Protected function Virtual

void

 

NotifyRequestToJoinRemoved

Protected function Virtual

void

 

NotifyRequestToJoinSent

(
    const FDateTime& ExpiresAt
)

Protected function

void

 

NotifyUserUnblocked

(
    ESocialSubsystem SubsystemType
)

Protected function

void

 

NotifyUserUnfriended

(
    ESocialSubsystem SubsystemType
)

Public function Const

USocialUser:...

 

OnBlockedStatusChanged()

Public function Const

FOnFriendRem...

 

OnFriendInviteRemoved()

Public function Const

USocialUser:...

 

OnFriendRemoved()

Public function Const

FPartyInvite...

 

OnPartyInviteAccepted()

Protected function Virtual Const

void

 

OnPartyInviteAcceptedInternal

(
    const FOnlinePartyTypeId& PartyTyp...
)

Public function Const

FPartyInvite...

 

OnPartyInviteRejected()

Protected function Virtual Const

void

 

OnPartyInviteRejectedInternal

(
    const FOnlinePartyTypeId& PartyTyp...
)

Protected function Virtual

void

 

OnPresenceChangedInternal

(
    ESocialSubsystem SubsystemType
)

Public function Const

FOnNicknameC...

 

OnSetNicknameCompleted()

Public function Const

USocialUser:...

 

OnSubsystemIdEstablished()

Public function Const

USocialUser:...

 

OnUserGameSpecificStatusChanged()

Public function Const

USocialUser:...

 

OnUserPresenceChanged()

Public function

void

 

RegisterInitCompleteHandler

(
    const FOnNewSocialUserInitialized&...
)

Public function Virtual Const

bool

 

RejectFriendInvite

(
    ESocialSubsystem SocialSubsystem
)

Public function

void

 

RejectPartyInvite

(
    const FOnlinePartyTypeId& PartyTyp...
)

Public function

void

 

RequestToJoinParty()

Public function Virtual

bool

 

SendFriendInvite

(
    ESocialSubsystem SubsystemType
)

Public function Virtual

bool

 

SetNickname

(
    const FString& InNickName
)

Protected function Virtual

void

 

SetSubsystemId

(
    ESocialSubsystem SubsystemType,
    const FUniqueNetIdRepl& SubsystemI...
)

Public function

bool

 

SetUserLocalAttribute

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

Public function

bool

 

ShowPlatformProfile()

Public function Const

FString

 

ToDebugString()

Protected function

void

 

TryBroadcastInitializationComplete()

Public function Virtual Const

bool

 

UnblockUser

(
    ESocialSubsystem Subsystem
)

Public function

void

 

ValidateFriendInfo

(
    ESocialSubsystem SubsystemType
)

Public function

void

 

WithContext

(
    const TMap< FString, FString >& In...,
    void&) Func
)

Classes

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

Constants

Name

Description

InitEventsByUser

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