1. Epic GamesDeveloper
  3. IOnlineFriends

IOnlineFriends

Interface definition for the online services friends services Friends services are anything related to the maintenance of friends and friends lists

API > API/Plugins > API/Plugins/OnlineSubsystem

Interface definition for the online services friends services Friends services are anything related to the maintenance of friends and friends lists

   
Name IOnlineFriends
Type class
Header File /Engine/Plugins/Online/OnlineSubsystem/Source/Public/Interfaces/OnlineFriendsInterface.h
Include Path #include "Interfaces/OnlineFriendsInterface.h"

Syntax

class IOnlineFriends

Constructors

Name Remarks Include Path Unreal Specifiers

IOnlineFriends()

   Interfaces/OnlineFriendsInterface.h  

Destructors

Name Remarks Include Path Unreal Specifiers

virtual ~IOnlineFriends()

   Interfaces/OnlineFriendsInterface.h  

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
OnBlockedPlayerCompleteDelegates FOnBlockedPlayerComplete Delegate used when a block player request has completed Interfaces/OnlineFriendsInterface.h  
OnBlockListChangeDelegates FOnBlockListChange Delegate used in block list change notifications Interfaces/OnlineFriendsInterface.h  
OnDeleteFriendCompleteDelegates FOnDeleteFriendComplete Delegate used when an friend delete request has completed Interfaces/OnlineFriendsInterface.h  
OnFriendRemovedDelegates FOnFriendRemoved Delegate called when a remote friend removes user from friends list Interfaces/OnlineFriendsInterface.h  
OnFriendsChangeDelegates FOnFriendsChange Delegate used in friends list change notifications Interfaces/OnlineFriendsInterface.h  
OnFriendSettingsUpdatedDelegates FOnFriendSettingsUpdated Delegate used when the friends settings are updated Interfaces/OnlineFriendsInterface.h  
OnInviteAbortedDelegates FOnInviteAborted Delegate called when a remote friend cancels/aborts an sent invite Interfaces/OnlineFriendsInterface.h  
OnInviteAcceptedDelegates FOnInviteAccepted Delegate called when a remote friend accepts an invite Interfaces/OnlineFriendsInterface.h  
OnInviteReceivedDelegates FOnInviteReceived Delegate called when remote friend sends an invite Interfaces/OnlineFriendsInterface.h  
OnInviteRejectedDelegates FOnInviteRejected Delegate called when a remote friend rejects an invite Interfaces/OnlineFriendsInterface.h  
OnOutgoingInviteSentDelegates FOnOutgoingInviteSent Delegate used in outgoing invite list change notifications Interfaces/OnlineFriendsInterface.h  
OnQueryBlockedPlayersCompleteDelegates FOnQueryBlockedPlayersComplete Delegate used when the query for blocked players has completed Interfaces/OnlineFriendsInterface.h  
OnQueryRecentPlayersCompleteDelegates FOnQueryRecentPlayersComplete Delegate used when the query for recent players has completed Interfaces/OnlineFriendsInterface.h  
OnRecentPlayersAddedDelegates FOnRecentPlayersAdded Delegate used when recent players have been added Interfaces/OnlineFriendsInterface.h  
OnRejectInviteCompleteDelegates FOnRejectInviteComplete Delegate used when an invite reject request has completed Interfaces/OnlineFriendsInterface.h  
OnUnblockedPlayerCompleteDelegates FOnUnblockedPlayerComplete Delegate used when an unblock player request has completed Interfaces/OnlineFriendsInterface.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

bool AcceptInvite ( int32 LocalUserNum,
const FUniqueNetId& FriendId,
const FString& ListName,
const FOnAcceptInviteComplete& Delegate
)

 Starts an async task that accepts an invite from another player. Interfaces/OnlineFriendsInterface.h  

virtual FDelegateHandle AddOnBlockedPlayerCompleteDelegate_Handle ( int32 LocalUserNum,
const FOnBlockedPlayerCompleteDelegate& Delegate
)

   Interfaces/OnlineFriendsInterface.h  

virtual FDelegateHandle AddOnBlockListChangeDelegate_Handle ( int32 LocalUserNum,
const FOnBlockListChangeDelegate& Delegate
)

   Interfaces/OnlineFriendsInterface.h  

virtual FDelegateHandle AddOnDeleteFriendCompleteDelegate_Handle ( int32 LocalUserNum,
const FOnDeleteFriendCompleteDelegate& Delegate
)

   Interfaces/OnlineFriendsInterface.h  

virtual FDelegateHandle AddOnFriendRemovedDelegate_Handle ( const FOnFriendRemovedDelegate& Delegate
)

   Interfaces/OnlineFriendsInterface.h  

virtual FDelegateHandle AddOnFriendsChangeDelegate_Handle ( int32 LocalUserNum,
const FOnFriendsChangeDelegate& Delegate
)

   Interfaces/OnlineFriendsInterface.h  

virtual FDelegateHandle AddOnFriendSettingsUpdatedDelegate_Handle ( const FOnFriendSettingsUpdatedDelegate& Delegate
)

   Interfaces/OnlineFriendsInterface.h  

virtual FDelegateHandle AddOnInviteAbortedDelegate_Handle ( const FOnInviteAbortedDelegate& Delegate
)

   Interfaces/OnlineFriendsInterface.h  

virtual FDelegateHandle AddOnInviteAcceptedDelegate_Handle ( const FOnInviteAcceptedDelegate& Delegate
)

   Interfaces/OnlineFriendsInterface.h  

virtual FDelegateHandle AddOnInviteReceivedDelegate_Handle ( const FOnInviteReceivedDelegate& Delegate
)

   Interfaces/OnlineFriendsInterface.h  

virtual FDelegateHandle AddOnInviteRejectedDelegate_Handle ( const FOnInviteRejectedDelegate& Delegate
)

   Interfaces/OnlineFriendsInterface.h  

virtual FDelegateHandle AddOnOutgoingInviteSentDelegate_Handle ( int32 LocalUserNum,
const FOnOutgoingInviteSentDelegate& Delegate
)

   Interfaces/OnlineFriendsInterface.h  

virtual FDelegateHandle AddOnQueryBlockedPlayersCompleteDelegate_Handle ( const FOnQueryBlockedPlayersCompleteDelegate& Delegate
)

   Interfaces/OnlineFriendsInterface.h  

virtual FDelegateHandle AddOnQueryRecentPlayersCompleteDelegate_Handle ( const FOnQueryRecentPlayersCompleteDelegate& Delegate
)

   Interfaces/OnlineFriendsInterface.h  

virtual FDelegateHandle AddOnRecentPlayersAddedDelegate_Handle ( const FOnRecentPlayersAddedDelegate& Delegate
)

   Interfaces/OnlineFriendsInterface.h  

virtual FDelegateHandle AddOnRejectInviteCompleteDelegate_Handle ( int32 LocalUserNum,
const FOnRejectInviteCompleteDelegate& Delegate
)

   Interfaces/OnlineFriendsInterface.h  

virtual FDelegateHandle AddOnUnblockedPlayerCompleteDelegate_Handle ( int32 LocalUserNum,
const FOnUnblockedPlayerCompleteDelegate& Delegate
)

   Interfaces/OnlineFriendsInterface.h  

virtual void AddRecentPlayers ( const FUniqueNetId& UserId,
const TArray< FReportPlayedWithUser >& InRecentPlayers,
const FString& ListName,
const FOnAddRecentPlayersComplete& InCompletionDelegate
)

 Add a list of players to a user's recent players list Interfaces/OnlineFriendsInterface.h  

bool BlockPlayer ( int32 LocalUserNum,
const FUniqueNetId& PlayerId
)

 Block a player Interfaces/OnlineFriendsInterface.h  

virtual void ClearOnBlockedPlayerCompleteDelegate_Handle ( int32 LocalUserNum,
FDelegateHandle& Handle
)

   Interfaces/OnlineFriendsInterface.h  

virtual void ClearOnBlockedPlayerCompleteDelegates ( int32 LocalUserNum,
FDelegateUserObject Object
)

   Interfaces/OnlineFriendsInterface.h  

virtual void ClearOnBlockListChangeDelegate_Handle ( int32 LocalUserNum,
FDelegateHandle& Handle
)

   Interfaces/OnlineFriendsInterface.h  

virtual void ClearOnBlockListChangeDelegates ( int32 LocalUserNum,
FDelegateUserObject Object
)

   Interfaces/OnlineFriendsInterface.h  

virtual void ClearOnDeleteFriendCompleteDelegate_Handle ( int32 LocalUserNum,
FDelegateHandle& Handle
)

   Interfaces/OnlineFriendsInterface.h  

virtual void ClearOnDeleteFriendCompleteDelegates ( int32 LocalUserNum,
FDelegateUserObject Object
)

   Interfaces/OnlineFriendsInterface.h  

virtual void ClearOnFriendRemovedDelegate_Handle ( FDelegateHandle& Handle
)

   Interfaces/OnlineFriendsInterface.h  

virtual void ClearOnFriendRemovedDelegates ( FDelegateUserObject Object
)

   Interfaces/OnlineFriendsInterface.h  

virtual void ClearOnFriendsChangeDelegate_Handle ( int32 LocalUserNum,
FDelegateHandle& Handle
)

   Interfaces/OnlineFriendsInterface.h  

virtual void ClearOnFriendsChangeDelegates ( int32 LocalUserNum,
FDelegateUserObject Object
)

   Interfaces/OnlineFriendsInterface.h  

virtual void ClearOnFriendSettingsUpdatedDelegate_Handle ( FDelegateHandle& Handle
)

   Interfaces/OnlineFriendsInterface.h  

virtual void ClearOnFriendSettingsUpdatedDelegates ( FDelegateUserObject Object
)

   Interfaces/OnlineFriendsInterface.h  

virtual void ClearOnInviteAbortedDelegate_Handle ( FDelegateHandle& Handle
)

   Interfaces/OnlineFriendsInterface.h  

virtual void ClearOnInviteAbortedDelegates ( FDelegateUserObject Object
)

   Interfaces/OnlineFriendsInterface.h  

virtual void ClearOnInviteAcceptedDelegate_Handle ( FDelegateHandle& Handle
)

   Interfaces/OnlineFriendsInterface.h  

virtual void ClearOnInviteAcceptedDelegates ( FDelegateUserObject Object
)

   Interfaces/OnlineFriendsInterface.h  

virtual void ClearOnInviteReceivedDelegate_Handle ( FDelegateHandle& Handle
)

   Interfaces/OnlineFriendsInterface.h  

virtual void ClearOnInviteReceivedDelegates ( FDelegateUserObject Object
)

   Interfaces/OnlineFriendsInterface.h  

virtual void ClearOnInviteRejectedDelegate_Handle ( FDelegateHandle& Handle
)

   Interfaces/OnlineFriendsInterface.h  

virtual void ClearOnInviteRejectedDelegates ( FDelegateUserObject Object
)

   Interfaces/OnlineFriendsInterface.h  

virtual void ClearOnOutgoingInviteSentDelegate_Handle ( int32 LocalUserNum,
FDelegateHandle& Handle
)

   Interfaces/OnlineFriendsInterface.h  

virtual void ClearOnOutgoingInviteSentDelegates ( int32 LocalUserNum,
FDelegateUserObject Object
)

   Interfaces/OnlineFriendsInterface.h  

virtual void ClearOnQueryBlockedPlayersCompleteDelegate_Handle ( FDelegateHandle& Handle
)

   Interfaces/OnlineFriendsInterface.h  

virtual void ClearOnQueryBlockedPlayersCompleteDelegates ( FDelegateUserObject Object
)

   Interfaces/OnlineFriendsInterface.h  

virtual void ClearOnQueryRecentPlayersCompleteDelegate_Handle ( FDelegateHandle& Handle
)

   Interfaces/OnlineFriendsInterface.h  

virtual void ClearOnQueryRecentPlayersCompleteDelegates ( FDelegateUserObject Object
)

   Interfaces/OnlineFriendsInterface.h  

virtual void ClearOnRecentPlayersAddedDelegate_Handle ( FDelegateHandle& Handle
)

   Interfaces/OnlineFriendsInterface.h  

virtual void ClearOnRecentPlayersAddedDelegates ( FDelegateUserObject Object
)

   Interfaces/OnlineFriendsInterface.h  

virtual void ClearOnRejectInviteCompleteDelegate_Handle ( int32 LocalUserNum,
FDelegateHandle& Handle
)

   Interfaces/OnlineFriendsInterface.h  

virtual void ClearOnRejectInviteCompleteDelegates ( int32 LocalUserNum,
FDelegateUserObject Object
)

   Interfaces/OnlineFriendsInterface.h  

virtual void ClearOnUnblockedPlayerCompleteDelegate_Handle ( int32 LocalUserNum,
FDelegateHandle& Handle
)

   Interfaces/OnlineFriendsInterface.h  

virtual void ClearOnUnblockedPlayerCompleteDelegates ( int32 LocalUserNum,
FDelegateUserObject Object
)

   Interfaces/OnlineFriendsInterface.h  

bool DeleteFriend ( int32 LocalUserNum,
const FUniqueNetId& FriendId,
const FString& ListName
)

 Starts an async task that deletes a friend from the named friends list Interfaces/OnlineFriendsInterface.h  

void DeleteFriendAlias ( int32 LocalUserNum,
const FUniqueNetId& FriendId,
const FString& ListName,
const FOnDeleteFriendAliasComplete& Delegate
)

 Starts an async task that delete an alias from a friend. Interfaces/OnlineFriendsInterface.h  

bool DeleteFriendsList ( int32 LocalUserNum,
const FString& ListName,
const FOnDeleteFriendsListComplete& Delegate
)

 Starts an async task that deletes the named friends list for the player Interfaces/OnlineFriendsInterface.h  

void DumpBlockedPlayers()

 Dump state information about blocked players Interfaces/OnlineFriendsInterface.h  

void DumpRecentPlayers()

 Dump state information about blocked players Interfaces/OnlineFriendsInterface.h  

bool GetBlockedPlayers ( const FUniqueNetId& UserId,
TArray< TSharedRef< FOnlineBlockedPlayer > >& OutBlockedPlayers
)

 Get the list of blocked players Interfaces/OnlineFriendsInterface.h  

TSharedPtr< FOnlineFriend > GetFriend ( int32 LocalUserNum,
const FUniqueNetId& FriendId,
const FString& ListName
)

 Get the cached friend entry if found Interfaces/OnlineFriendsInterface.h  

virtual EFriendInvitePolicy GetFriendInvitePolicy ( const FUniqueNetId& UserId
) const

 Gets the FriendInvitePolicy info that defines who can send friend invites to the user. Interfaces/OnlineFriendsInterface.h  

virtual bool GetFriendSettings ( const FUniqueNetId& UserId,
TMap< FString, TSharedRef< FOnlineFriendSettingsSourceData > >& OutSettings
)

 Gets the cached information we have stored from a third party source Interfaces/OnlineFriendsInterface.h  

bool GetFriendsList ( int32 LocalUserNum,
const FString& ListName,
TArray< TSharedRef< FOnlineFriend > >& OutFriends
)

 Copies the list of friends for the player previously retrieved from the online service Interfaces/OnlineFriendsInterface.h  

bool GetRecentPlayers ( const FUniqueNetId& UserId,
const FString& Namespace,
TArray< TSharedRef< FOnlineRecentPlayer > >& OutRecentPlayers
)

 Copies the cached list of recent players for a given user Interfaces/OnlineFriendsInterface.h  

bool IsFriend ( int32 LocalUserNum,
const FUniqueNetId& FriendId,
const FString& ListName
)

 Checks that a unique player id is part of the specified user's friends list Interfaces/OnlineFriendsInterface.h  

bool QueryBlockedPlayers ( const FUniqueNetId& UserId
)

 Query for blocked players Interfaces/OnlineFriendsInterface.h  

virtual void QueryFriendSettings ( const FUniqueNetId& LocalUserId,
FOnSettingsOperationComplete Delegate
)

 Query the current friend settings Interfaces/OnlineFriendsInterface.h  

virtual bool QueryFriendSettings ( const FUniqueNetId& UserId,
const FString& Source,
const FOnQueryFriendSettingsComplete& Delegate
)

 Queries the settings we have stored for a third party source Interfaces/OnlineFriendsInterface.h  

bool QueryRecentPlayers ( const FUniqueNetId& UserId,
const FString& Namespace
)

 Query for recent players of the current user Interfaces/OnlineFriendsInterface.h  

bool ReadFriendsList ( int32 LocalUserNum,
const FString& ListName,
const FOnReadFriendsListComplete& Delegate
)

 Starts an async task that reads the named friends list for the player Interfaces/OnlineFriendsInterface.h  

bool RejectInvite ( int32 LocalUserNum,
const FUniqueNetId& FriendId,
const FString& ListName
)

 Starts an async task that rejects an invite from another player. Interfaces/OnlineFriendsInterface.h  

bool SendInvite ( int32 LocalUserNum,
const FUniqueNetId& FriendId,
const FString& ListName,
const FOnSendInviteComplete& Delegate
)

 Starts an async task that sends an invite to another player. Interfaces/OnlineFriendsInterface.h  

void SetFriendAlias ( int32 LocalUserNum,
const FUniqueNetId& FriendId,
const FString& ListName,
const FString& Alias,
const FOnSetFriendAliasComplete& Delegate
)

 Starts an async task that sets an alias a to friend. Interfaces/OnlineFriendsInterface.h  

virtual bool SetFriendSettings ( const FUniqueNetId& UserId,
const FString& Source,
bool bNeverShowAgain,
const FOnSetFriendSettingsComplete& Delegate
)

 Set information we want to store for a third party source Interfaces/OnlineFriendsInterface.h  

virtual void TriggerOnBlockedPlayerCompleteDelegates ( int32 LocalUserNum,
bool Param1,
const FUniqueNetId& Param2,
const FString& Param3,
const FString& Param4
)

   Interfaces/OnlineFriendsInterface.h  

virtual void TriggerOnBlockListChangeDelegates ( int32 LocalUserNum,
const FString& Param1
)

   Interfaces/OnlineFriendsInterface.h  

virtual void TriggerOnDeleteFriendCompleteDelegates ( int32 LocalUserNum,
bool Param1,
const FUniqueNetId& Param2,
const FString& Param3,
const FString& Param4
)

   Interfaces/OnlineFriendsInterface.h  

virtual void TriggerOnFriendRemovedDelegates ( const FUniqueNetId& Param1,
const FUniqueNetId& Param2
)

   Interfaces/OnlineFriendsInterface.h  

virtual void TriggerOnFriendsChangeDelegates ( int32 LocalUserNum
)

   Interfaces/OnlineFriendsInterface.h  

virtual void TriggerOnFriendSettingsUpdatedDelegates ( const FUniqueNetId& Param1,
bool Param2,
bool Param3,
const FFriendSettings& Param4,
const FString& Param5
)

   Interfaces/OnlineFriendsInterface.h  

virtual void TriggerOnInviteAbortedDelegates ( const FUniqueNetId& Param1,
const FUniqueNetId& Param2
)

   Interfaces/OnlineFriendsInterface.h  

virtual void TriggerOnInviteAcceptedDelegates ( const FUniqueNetId& Param1,
const FUniqueNetId& Param2
)

   Interfaces/OnlineFriendsInterface.h  

virtual void TriggerOnInviteReceivedDelegates ( const FUniqueNetId& Param1,
const FUniqueNetId& Param2
)

   Interfaces/OnlineFriendsInterface.h  

virtual void TriggerOnInviteRejectedDelegates ( const FUniqueNetId& Param1,
const FUniqueNetId& Param2
)

   Interfaces/OnlineFriendsInterface.h  

virtual void TriggerOnOutgoingInviteSentDelegates ( int32 LocalUserNum
)

   Interfaces/OnlineFriendsInterface.h  

virtual void TriggerOnQueryBlockedPlayersCompleteDelegates ( const FUniqueNetId& Param1,
bool Param2,
const FString& Param3
)

   Interfaces/OnlineFriendsInterface.h  

virtual void TriggerOnQueryRecentPlayersCompleteDelegates ( const FUniqueNetId& Param1,
const FString& Param2,
bool Param3,
const FString& Param4
)

   Interfaces/OnlineFriendsInterface.h  

virtual void TriggerOnRecentPlayersAddedDelegates ( const FUniqueNetId& Param1,
const TArray< TSharedRef< FOnlineRecentPlayer > >& Param2
)

   Interfaces/OnlineFriendsInterface.h  

virtual void TriggerOnRejectInviteCompleteDelegates ( int32 LocalUserNum,
bool Param1,
const FUniqueNetId& Param2,
const FString& Param3,
const FString& Param4
)

   Interfaces/OnlineFriendsInterface.h  

virtual void TriggerOnUnblockedPlayerCompleteDelegates ( int32 LocalUserNum,
bool Param1,
const FUniqueNetId& Param2,
const FString& Param3,
const FString& Param4
)

   Interfaces/OnlineFriendsInterface.h  

bool UnblockPlayer ( int32 LocalUserNum,
const FUniqueNetId& PlayerId
)

 Unblock a player Interfaces/OnlineFriendsInterface.h  

virtual void UpdateFriendInvitePolicySettings ( const FUniqueNetId& LocalUserId,
const EFriendInvitePolicy FriendInvitePolicy,
const bool bAffectsExistingInvites,
FOnSettingsOperationComplete Delegate
)

 Update the current friend settings Interfaces/OnlineFriendsInterface.h  

Protected

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page