Can't find any content

Error loading documents tree: Nothing found

  1. Epic GamesDeveloper
  3. USocialToolkit

USocialToolkit

Represents the full suite of social functionality available to a given LocalPlayer

API > API/Plugins > API/Plugins/Party

Represents the full suite of social functionality available to a given LocalPlayer

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

Syntax

UCLASS (MinimalAPI, Within=SocialManager, Config=Game)  
class USocialToolkit :  
    public UObject ,  
    public FExec

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

USocialToolkit()

   SocialToolkit.h  

Classes

Name Remarks
FBasicToolkitEvent  
FFriendInviteEvent  
FOnKnownUserInitialized  
FOnPartyRequestToJoinReceivedEvent  
FOnPartyRequestToJoinRemovedEvent  
FOnPartyRequestToJoinSentEvent  
FOnRelationshipEstablished  
FOnSocialUserInvalidated  
FPartyInviteEvent  

Typedefs

Name Type Remarks Include Path
FOnLoginChanged TMulticastDelegate_OneParam< void, bool > Event triggered when the owning local player's login status changes SocialToolkit.h

Constants

Name Type Remarks Include Path
AllToolkitsByOwningPlayer TMap< TWeakObjectPtr< const ULocalPlayer >, TWeakObjectPtr< USocialToolkit > >   SocialToolkit.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
AllUsers TArray< TObjectPtr< USocialUser > >   SocialToolkit.h  
bDebug_IsRandomlyChangingUserPresence bool   SocialToolkit.h  
BlockedUsers TMap< ESocialSubsystem, TSet< FUniqueNetIdRepl > >   SocialToolkit.h  
bRemoveInvalidatedUserFromMaps bool   SocialToolkit.h
  • Config
CachedSocialUserLists TArray< TWeakPtr< FSocialUserList > >   SocialToolkit.h  
Debug_PresenceTickerHandle FTSTicker::FDelegateHandle   SocialToolkit.h  
LocalPlayerOwner TWeakObjectPtr< ULocalPlayer >   SocialToolkit.h  
LocalUser TObjectPtr< USocialUser >   SocialToolkit.h  
OnFriendInviteReceivedEvent FFriendInviteEvent   SocialToolkit.h  
OnFriendInviteSentEvent FFriendInviteEvent   SocialToolkit.h  
OnFriendshipEstablishedEvent FOnRelationshipEstablished   SocialToolkit.h  
OnKnownUserInitializedEvent FOnKnownUserInitialized   SocialToolkit.h  
OnLoginChangedEvent FOnLoginChanged   SocialToolkit.h  
OnPartyInviteAcceptedEvent FPartyInviteEvent   SocialToolkit.h  
OnPartyInviteReceivedEvent FPartyInviteEvent   SocialToolkit.h  
OnPartyInviteRejectedEvent FPartyInviteEvent   SocialToolkit.h  
OnPartyInviteRemovedEvent FPartyInviteEvent   SocialToolkit.h  
OnPartyRequestToJoinReceivedEvent FOnPartyRequestToJoinReceivedEvent   SocialToolkit.h  
OnPartyRequestToJoinRemovedEvent FOnPartyRequestToJoinRemovedEvent   SocialToolkit.h  
OnPartyRequestToJoinSentEvent FOnPartyRequestToJoinSentEvent   SocialToolkit.h  
OnPresenceUpdatedHandles TMap< ESocialSubsystem, UE::Online::FOnlineEventDelegateHandle >   SocialToolkit.h  
OnRecentPlayerAddedEvent FOnRelationshipEstablished   SocialToolkit.h  
OnSocialUserInvalidatedEvent FOnSocialUserInvalidated   SocialToolkit.h  
OnToolkitResetEvent FBasicToolkitEvent   SocialToolkit.h  
OnUserBlockedEvent FOnRelationshipEstablished   SocialToolkit.h  
PartyInvitations TSet< IOnlinePartyJoinInfoConstRef >   SocialToolkit.h  
UsersBySubsystemIds TMap< FUniqueNetIdRepl, TWeakObjectPtr< USocialUser > >   SocialToolkit.h  
USocialChatManager friend   SocialToolkit.h  
USocialUser friend   SocialToolkit.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

void AddLocalUserOnlineProperties ( FPresenceProperties OnlineProperties
)

   SocialToolkit.h  

virtual bool CanAutoRecreatePersistentParty()

 Can we automatically re-create a persistent party, for example on party join failure or on party kick? Typically you will want to, so the user always has a party, but there may be scenarios where you want to delay creating a new party until the client is in a better state. SocialToolkit.h  

TSharedRef< ISocialUserList > CreateUserList ( const FSocialUserListConfig& ListConfig
) const

   SocialToolkit.h  

bool Debug_IsRandomlyChangingPresence()

   SocialToolkit.h  

USocialUser * FindUser ( const FUniqueNetIdRepl& UserId
) const

 Finds a SocialUser given a unique net ID from any OSS SocialToolkit.h  

const TArray< USocialUser * > & GetAllUsers()

   SocialToolkit.h  

bool GetAuthAttribute ( ESocialSubsystem SubsystemType,
const FString& AttributeKey,
FString& OutValue
) const

   SocialToolkit.h  

USocialChatManager & GetChatManager()

   SocialToolkit.h  

USocialUser & GetLocalUser()

   SocialToolkit.h  

FUniqueNetIdRepl GetLocalUserNetId ( ESocialSubsystem SubsystemType
) const

   SocialToolkit.h  

int32 GetLocalUserNum()

   SocialToolkit.h  

ULocalPlayer * GetOwningLocalPlayerPtr()

   SocialToolkit.h  

const FOnlineUserPresence * GetPresenceInfo ( ESocialSubsystem SubsystemType
) const

   SocialToolkit.h  

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

   SocialToolkit.h  

const FString & GetRecentPlayerNamespaceToQuery()

   SocialToolkit.h  

USocialManager & GetSocialManager()

   SocialToolkit.h  

IOnlineSubsystem * GetSocialOss ( ESocialSubsystem SubsystemType
) const

   SocialToolkit.h  

virtual void InitializeToolkit ( ULocalPlayer& InOwningLocalPlayer
)

   SocialToolkit.h  

virtual bool IsFriendshipRestricted ( const USocialUser& SocialUser,
ESocialSubsystem SubsystemType
) const

   SocialToolkit.h  

virtual bool IsOwnerLoggedIn()

   SocialToolkit.h  

virtual void NotifyPartyInviteReceived ( USocialUser& SocialUser,
const IOnlinePartyJoinInfo& Invite
)

   SocialToolkit.h  

virtual void NotifyPartyInviteRemoved ( USocialUser& SocialUser,
const IOnlinePartyJoinInfo& Invite
)

   SocialToolkit.h  

FFriendInviteEvent & OnFriendInviteReceived()

   SocialToolkit.h  

FFriendInviteEvent & OnFriendInviteSent()

   SocialToolkit.h  

FOnRelationshipEstablished & OnFriendshipEstablished()

   SocialToolkit.h  

FOnKnownUserInitialized & OnKnownUserInitialized()

   SocialToolkit.h  

FOnLoginChanged & OnLoginChanged()

   SocialToolkit.h  

FPartyInviteEvent & OnPartyInviteReceived()

   SocialToolkit.h  

FPartyInviteEvent & OnPartyInviteRemoved()

   SocialToolkit.h  

FOnPartyRequestToJoinReceivedEvent & OnPartyRequestToJoinReceived()

   SocialToolkit.h  

FOnPartyRequestToJoinRemovedEvent & OnPartyRequestToJoinRemoved()

   SocialToolkit.h  

FOnPartyRequestToJoinSentEvent & OnPartyRequestToJoinSent()

   SocialToolkit.h  

FOnRelationshipEstablished & OnRecentPlayerAdded()

   SocialToolkit.h  

FOnSocialUserInvalidated & OnSocialUserInvalidated()

   SocialToolkit.h  

FBasicToolkitEvent & OnToolkitReset()

   SocialToolkit.h  

FOnRelationshipEstablished & OnUserBlocked()

   SocialToolkit.h  

void QueueUserDependentAction ( const FUniqueNetIdRepl& SubsystemId,
FUserDependentAction UserActionDelegate
)

   SocialToolkit.h  

void QueueUserDependentAction ( const FUniqueNetIdRepl& UserId,
TFunction< void(USocialUser&)>&& UserActionFunc,
bool bExecutePostInit
)

 Queues an action to be executed when a USocialUser corresponding to the given UniqueId has been established. SocialToolkit.h  

virtual void SetLocalUserOnlineState ( EOnlinePresenceState::Type OnlineState
)

   SocialToolkit.h  

virtual void SetLocalUserOnlineStateV2 ( UE::Online::EUserPresenceStatus OnlineState
)

   SocialToolkit.h  

void TrySendFriendInvite ( const FString& DisplayNameOrEmail
) const

 Attempts to send a friend invite to another user based on display name or email. SocialToolkit.h  

Protected

Name Remarks Include Path Unreal Specifiers

bool AcceptFriendInvite ( const USocialUser& SocialUser,
ESocialSubsystem SubsystemType
) const

   SocialToolkit.h  

virtual bool AcceptFriendInviteInternal ( const USocialUser& SocialUser,
ESocialSubsystem SubsystemType
) const

 Only handles accepting a friend request via the friends interface, assumes all checks are handled previously SocialToolkit.h  

TSubclassOf< USocialChatManager > GetChatManagerClass()

   SocialToolkit.h  

void HandleAcceptFriendInviteComplete ( int32 LocalUserNum,
bool bWasSuccessful,
const FUniqueNetId& InviterUserId,
const FString& ListName,
const FString& ErrorStr
)

 Handle result of AcceptFriendInvite SocialToolkit.h  

void HandleSendFriendInviteComplete ( int32 LocalUserNum,
bool bWasSuccessful,
const FUniqueNetId& InvitedUserId,
const FString& ListName,
const FString& ErrorStr,
ESocialSubsystem SubsystemType,
FString DisplayName
)

 Handle result of TrySendFriendInviteInternal SocialToolkit.h  

void HandleUserInvalidated ( USocialUser& InvalidUser
)

   SocialToolkit.h  

virtual const bool IsInviteAllowedFromUser ( const USocialUser& User,
const TSharedRef< const IOnlinePartyJoinInfo >& InviteRef
) const

 Whether we allow other users to send us invites SocialToolkit.h  

void NotifySubsystemIdEstablished ( USocialUser& SocialUser,
ESocialSubsystem SubsystemType,
const FUniqueNetIdRepl& SubsystemId
)

   SocialToolkit.h  

virtual void OnAcceptFriendInviteComplete ( const FUniqueNetId& InviterUserId,
bool bInviteSucceeded,
const FString& InviteError
)

   SocialToolkit.h  

virtual void OnBlockPlayerComplete ( int32 LocalUserNum,
bool bWasSuccessful,
const FUniqueNetId& BlockedPlayerID,
const FString& ListName,
const FString& ErrorStr,
ESocialSubsystem SubsystemType
)

   SocialToolkit.h  

virtual void OnDeleteFriendComplete ( int32 LocalPlayer,
bool bWasSuccessful,
const FUniqueNetId& FormerFriendId,
const FString& ListName,
const FString& ErrorStr,
ESocialSubsystem SubsystemType
)

   SocialToolkit.h  

virtual void OnFriendPresenceDidChange ( const USocialUser& FriendSocialUser,
const TSharedRef< FOnlineUserPresence >& NewPresence,
ESocialSubsystem SubsystemType
)

 Called when a Friend's presence did change SocialToolkit.h  

virtual void OnFriendPresenceDidChangeV2 ( const USocialUser& FriendSocialUser,
const TSharedRef< const UE::Online::FUserPresence >& NewPresence,
ESocialSubsystem SubsystemType
)

   SocialToolkit.h  

virtual void OnOwnerLoggedIn()

   SocialToolkit.h  

virtual void OnOwnerLoggedOut()

   SocialToolkit.h  

virtual void OnQueryBlockedPlayersComplete ( const FUniqueNetId& UserId,
bool bWasSuccessful,
const FString& ErrorStr,
ESocialSubsystem SubsystemType
)

   SocialToolkit.h  

virtual void OnQueryBlockedPlayersSuccess ( ESocialSubsystem SubsystemType,
const TArray< TSharedRef< FOnlineBlockedPlayer > >& BlockedPlayers
)

   SocialToolkit.h  

virtual void OnQueryFriendsListSuccess ( ESocialSubsystem SubsystemType,
const TArray< TSharedRef< FOnlineFriend > >& FriendsList
)

   SocialToolkit.h  

virtual void OnQueryRecentPlayersComplete ( const FUniqueNetId& UserId,
const FString& Namespace,
bool bWasSuccessful,
const FString& ErrorStr,
ESocialSubsystem SubsystemType
)

   SocialToolkit.h  

virtual void OnQueryRecentPlayersSuccess ( ESocialSubsystem SubsystemType,
const TArray< TSharedRef< FOnlineRecentPlayer > >& FriendsList
)

   SocialToolkit.h  

virtual void OnReadFriendsListComplete ( int32 LocalUserNum,
bool bWasSuccessful,
const FString& ListName,
const FString& ErrorStr,
ESocialSubsystem SubsystemType
)

   SocialToolkit.h  

virtual void OnSendFriendInviteComplete ( const FUniqueNetId& InvitedUserId,
const FString& InviteeName,
bool bInviteSuceeded,
const FString& InviteError
)

   SocialToolkit.h  

virtual void OnUnblockPlayerComplete ( int32 LocalUserNum,
bool bWasSuccessful,
const FUniqueNetId& UnblockedPlayerID,
const FString& ListName,
const FString& ErrorStr,
ESocialSubsystem SubsystemType
)

   SocialToolkit.h  

void QueryBlockedPlayers()

   SocialToolkit.h  

void QueryFriendsLists()

   SocialToolkit.h  

void QueryRecentPlayers()

   SocialToolkit.h  

virtual bool SendFriendInviteInternal ( USocialUser& SocialUser,
ESocialSubsystem SubsystemType
) const

 Only handles sending a friend request via the friends interface, assumes all checks are handled previously SocialToolkit.h  

bool TrySendFriendInvite ( USocialUser& SocialUser,
ESocialSubsystem SubsystemType
) const

   SocialToolkit.h  

Static

Name Remarks Include Path Unreal Specifiers

static ToolkitT * GetToolkitForPlayer ( const ULocalPlayer* LocalPlayer
)

   SocialToolkit.h  

static USocialToolkit * GetToolkitForPlayerInternal ( const ULocalPlayer* LocalPlayer
)

   SocialToolkit.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page