1. Epic GamesDeveloper
  3. USocialToolkit

USocialToolkit

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

API > API/Plugins > API/Plugins/Party

Inheritance Hierarchy

References

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

Syntax

UCLASS&40;Within&61;SocialManager, Config&61;Game&41;  
class USocialToolkit :  
    public UObject,  
    public FExec

Remarks

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

Variables

  Type Name Description
Protected variable bool bQueryBlockedPlayersOnStartup  
Protected variable bool bQueryFriendsOnStartup Something nicer is definitely possible and worth revisiting.
Protected variable bool bQueryRecentPlayersOnStartup  
Protected variable TSubclassOf< USocialChatManager > ChatManagerClass Class to use when creating the ChatManager
Protected variable FString FriendListToQuery The name of the friends list to query
Protected variable FString RecentPlayerNamespaceToQuery The name of the recent player namespace to query
Protected variable TSubclassOf< USocialUser > SocialUserClass The type of SocialUser to create to represent known users

Constructors

  Type Name Description
Public function    

Functions

  Type Name Description
Protected function Const bool

AcceptFriendInvite ( const USocialUser& SocialUser,
ESocialSubsystem SubsystemType
)

  
Protected function Virtual Const bool

AcceptFriendInviteInternal ( const USocialUser& SocialUser,
ESocialSubsystem SubsystemType
)

 Only handles accepting a friend request via the friends interface, assumes all checks are handled previously
Public function void  
Public function Virtual Const bool 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.
Public function Const TSharedRef< ISocialUserList >

CreateUserList ( const FSocialUserListConfig& ListConfig
)

  
Public function Const bool  
Public function Const USocialUser *

FindUser ( const FUniqueNetIdRepl& UserId
)

 Finds a SocialUser given a unique net ID from any OSS
Public function Const const TArray< USocialUser * > &  
Public function Const bool

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

  
Public function Const USocialChatManager &  
Protected function TSubclassOf< USocialChatManager >  
Public function Const USocialUser &  
Public function Const FUniqueNetIdRepl  
Public function Const int32  
Public function Const ULocalPlayer &  
Public function Const const FOnlineUserPresence *

GetPresenceInfo ( ESocialSubsystem SubsystemType
)

  
Public function Const const FString &  
Public function Const USocialManager &  
Public function Const IOnlineSubsystem *

GetSocialOss ( ESocialSubsystem SubsystemType
)

  
Public function Static ToolkitT *

GetToolkitForPlayer ( const ULocalPlayer* LocalPlayer
)

  
Protected function void

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

 Handle result of AcceptFriendInvite
Protected function void

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

 Handle result of TrySendFriendInviteInternal
Protected function void  
Public function Virtual void

InitializeToolkit ( ULocalPlayer& InOwningLocalPlayer
)

  
Public function Virtual Const bool

IsFriendshipRestricted ( const USocialUser& SocialUser,
ESocialSubsystem SubsystemType
)

  
Protected function Virtual Const const bool

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

 Whether we allow other users to send us invites
Public function Virtual Const bool  
Public function Virtual void  
Public function Virtual void  
Protected function void

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

  
Protected function Virtual void

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

  
Protected function Virtual void

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

  
Protected function Virtual void

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

  
Public function Const FFriendInviteEvent &  
Public function Const FFriendInviteEvent &  
Protected function Virtual void

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

 Called when a Friend's presence did change
Public function Const FOnRelationshipEstablished &  
Public function FOnKnownUserInitialized &  
Protected function Virtual void  
Protected function Virtual void  
Public function Const FPartyInviteEvent &  
Public function Const FPartyInviteEvent &  
Public function Const FOnPartyRequestToJoinReceivedEvent &  
Public function Const FOnPartyRequestToJoinRemovedEvent &  
Public function Const FOnPartyRequestToJoinSentEvent &  
Protected function Virtual void

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

  
Protected function Virtual void  
Protected function Virtual void

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

  
Protected function Virtual void

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

  
Protected function Virtual void  
Protected function Virtual void

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

  
Public function Const FOnRelationshipEstablished &  
Protected function Virtual void

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

  
Public function FOnSocialUserInvalidated &  
Public function Const FBasicToolkitEvent &  
Protected function Virtual void

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

  
Public function Const FOnRelationshipEstablished &  
Protected function void  
Protected function void  
Protected function void  
Public function void

QueueUserDependentAction ( const FUniqueNetIdRepl& SubsystemId,
FUserDependentAction UserActionDelegate
)

 Queues an action to be executed when a USocialUser corresponding to the given UniqueId has been established.
Public function 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.
Protected function Virtual Const bool

SendFriendInviteInternal ( USocialUser& SocialUser,
ESocialSubsystem SubsystemType
)

 Only handles sending a friend request via the friends interface, assumes all checks are handled previously
Public function void  
Public function Const void

TrySendFriendInvite ( const FString& DisplayNameOrEmail
)

 Attempts to send a friend invite to another user based on display name or email.
Protected function Const bool

TrySendFriendInvite ( USocialUser& SocialUser,
ESocialSubsystem SubsystemType
)

  

Classes

  Type Name Description
Public class FBasicToolkitEvent    
Public class FFriendInviteEvent    
Public class FOnKnownUserInitialized    
Public class FOnPartyRequestToJoinReceivedEvent    
Public class FOnPartyRequestToJoinRemovedEvent    
Public class FOnPartyRequestToJoinSentEvent    
Public class FOnRelationshipEstablished    
Public class FOnSocialUserInvalidated    
Public class FPartyInviteEvent    

Constants

Name Description
AllToolkitsByOwningPlayer  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page