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

Unreal Engine C++ API Reference > Plugins > OnlineSubsystem > Interfaces

References

   
Module OnlineSubsystem
Header /Engine/Plugins/Online/OnlineSubsystem/Source/Public/Interfaces/OnlineFriendsInterface.h
Include #include "Interfaces/OnlineFriendsInterface.h"

Syntax

class IOnlineFriends

Remarks

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

Variables

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

Constructors

  Type Name Description
Protected function    

Destructors

  Type Name Description
Public function Virtual    

Functions

  Type Name Description
Public function bool

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

 Starts an async task that accepts an invite from another player.
Public function Virtual FDelegateHandle  
Public function Virtual FDelegateHandle  
Public function Virtual FDelegateHandle  
Public function Virtual FDelegateHandle  
Public function Virtual FDelegateHandle  
Public function Virtual FDelegateHandle  
Public function Virtual FDelegateHandle  
Public function Virtual FDelegateHandle  
Public function Virtual FDelegateHandle  
Public function Virtual FDelegateHandle  
Public function Virtual FDelegateHandle  
Public function Virtual FDelegateHandle  
Public function Virtual FDelegateHandle  
Public function Virtual FDelegateHandle  
Public function Virtual FDelegateHandle  
Public function Virtual FDelegateHandle  
Public function 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
Public function bool

BlockPlayer ( int32 LocalUserNum,
const FUniqueNetId& PlayerId
)

 Block a player
Public function Virtual void  
Public function Virtual void

ClearOnBlockedPlayerCompleteDelegates ( int32 LocalUserNum,
void* Object
)

  
Public function Virtual void  
Public function Virtual void

ClearOnBlockListChangeDelegates ( int32 LocalUserNum,
void* Object
)

  
Public function Virtual void  
Public function Virtual void

ClearOnDeleteFriendCompleteDelegates ( int32 LocalUserNum,
void* Object
)

  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void

ClearOnFriendsChangeDelegates ( int32 LocalUserNum,
void* Object
)

  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void

ClearOnOutgoingInviteSentDelegates ( int32 LocalUserNum,
void* Object
)

  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void

ClearOnRejectInviteCompleteDelegates ( int32 LocalUserNum,
void* Object
)

  
Public function Virtual void  
Public function Virtual void

ClearOnUnblockedPlayerCompleteDelegates ( int32 LocalUserNum,
void* Object
)

  
Public function bool

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

 Starts an async task that deletes a friend from the named friends list
Public function void

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

 Starts an async task that delete an alias from a friend.
Public function bool

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

 Starts an async task that deletes the named friends list for the player
Public function Const void Dump state information about blocked players
Public function Const void Dump state information about blocked players
Public function bool

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

 Get the list of blocked players
Public function TSharedPtr< FOnlineFriend >

GetFriend ( int32 LocalUserNum,
const FUniqueNetId& FriendId,
const FString& ListName
)

 Get the cached friend entry if found
Public function Virtual Const EFriendInvitePolicy Gets the FriendInvitePolicy info that defines who can send friend invites to the user.
Public function Virtual bool Gets the cached information we have stored from a third party source
Public function 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
Public function bool

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

 Copies the cached list of recent players for a given user
Public function 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
Public function bool

QueryBlockedPlayers ( const FUniqueNetId& UserId
)

 Query for blocked players
Public function Virtual void Query the current friend settings
Public function Virtual bool

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

 Queries the settings we have stored for a third party source
Public function bool

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

 Query for recent players of the current user
Public function bool

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

 Starts an async task that reads the named friends list for the player
Public function bool

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

 Starts an async task that rejects an invite from another player.
Public function bool

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

 Starts an async task that sends an invite to another player.
Public function 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.
Public function 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
Public function Virtual void

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

  
Public function Virtual void

TriggerOnBlockListChangeDelegates ( int32 LocalUserNum,
const FString& Param1
)

  
Public function Virtual void

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

  
Public function Virtual void

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

  
Public function Virtual void  
Public function Virtual void

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

  
Public function Virtual void

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

  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void  
Public function Virtual void

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

  
Public function Virtual void

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

  
Public function Virtual void  
Public function Virtual void

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

  
Public function Virtual void

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

  
Public function bool

UnblockPlayer ( int32 LocalUserNum,
const FUniqueNetId& PlayerId
)

 Unblock a player
Public function Virtual void

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

 Update the current friend settings

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page