IOnlineFriends

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

Windows
MacOS
Linux

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

Name Description

Public variable

FOnBlockedPlaye...

 

OnBlockedPlayerCompleteDelegates

Delegate used when a block player request has completed

Public variable

FOnBlockListCha...

 

OnBlockListChangeDelegates

Delegate used in block list change notifications

Public variable

FOnDeleteFriend...

 

OnDeleteFriendCompleteDelegates

Delegate used when an friend delete request has completed

Public variable

FOnFriendRemove...

 

OnFriendRemovedDelegates

Delegate called when a remote friend removes user from friends list

Public variable

FOnFriendsChang...

 

OnFriendsChangeDelegates

Delegate used in friends list change notifications

Public variable

FOnInviteAborte...

 

OnInviteAbortedDelegates

Delegate called when a remote friend cancels/aborts an sent invite

Public variable

FOnInviteAccept...

 

OnInviteAcceptedDelegates

Delegate called when a remote friend accepts an invite

Public variable

FOnInviteReceiv...

 

OnInviteReceivedDelegates

Delegate called when remote friend sends an invite

Public variable

FOnInviteReject...

 

OnInviteRejectedDelegates

Delegate called when a remote friend rejects an invite

Public variable

FOnOutgoingInvi...

 

OnOutgoingInviteSentDelegates

Delegate used in outgoing invite list change notifications

Public variable

FOnQueryBlocked...

 

OnQueryBlockedPlayersCompleteDelegates

Delegate used when the query for blocked players has completed

Public variable

FOnQueryRecentP...

 

OnQueryRecentPlayersCompleteDelegates

Delegate used when the query for recent players has completed

Public variable

FOnRecentPlayer...

 

OnRecentPlayersAddedDelegates

Delegate used when recent players have been added

Public variable

FOnRejectInvite...

 

OnRejectInviteCompleteDelegates

Delegate used when an invite reject request has completed

Public variable

FOnUnblockedPla...

 

OnUnblockedPlayerCompleteDelegates

Delegate used when an unblock player request has completed

Constructors

Name Description

Protected function

IOnlineFriends()

Destructors

Name Description

Public function Virtual

~IOnlineFriends()

Functions

Name Description

Public function

bool

 

AcceptInvite

(
    int32 LocalUserNum,
    const FUniqueNetId& FriendId,
    const FString& ListName,
    const FOnAcceptInviteComplete& Del...
)

Starts an async task that accepts an invite from another player.

Public function Virtual

FDelegateHan...

 

AddOnBlockedPlayerCompleteDelegate_Handle

(
    int32 LocalUserNum,
    const FOnBlockedPlayerCompleteDeleg...
)

Public function Virtual

FDelegateHan...

 

AddOnBlockListChangeDelegate_Handle

(
    int32 LocalUserNum,
    const FOnBlockListChangeDelegate& ...
)

Public function Virtual

FDelegateHan...

 

AddOnDeleteFriendCompleteDelegate_Handle

(
    int32 LocalUserNum,
    const FOnDeleteFriendCompleteDelega...
)

Public function Virtual

FDelegateHan...

 

AddOnFriendRemovedDelegate_Handle

(
    const FOnFriendRemovedDelegate& De...
)

Public function Virtual

FDelegateHan...

 

AddOnFriendsChangeDelegate_Handle

(
    int32 LocalUserNum,
    const FOnFriendsChangeDelegate& De...
)

Public function Virtual

FDelegateHan...

 

AddOnInviteAbortedDelegate_Handle

(
    const FOnInviteAbortedDelegate& De...
)

Public function Virtual

FDelegateHan...

 

AddOnInviteAcceptedDelegate_Handle

(
    const FOnInviteAcceptedDelegate& D...
)

Public function Virtual

FDelegateHan...

 

AddOnInviteReceivedDelegate_Handle

(
    const FOnInviteReceivedDelegate& D...
)

Public function Virtual

FDelegateHan...

 

AddOnInviteRejectedDelegate_Handle

(
    const FOnInviteRejectedDelegate& D...
)

Public function Virtual

FDelegateHan...

 

AddOnOutgoingInviteSentDelegate_Handle

(
    int32 LocalUserNum,
    const FOnOutgoingInviteSentDelegate...
)

Public function Virtual

FDelegateHan...

 

AddOnQueryBlockedPlayersCompleteDelegate_Handle

(
    const FOnQueryBlockedPlayersComplet...
)

Public function Virtual

FDelegateHan...

 

AddOnQueryRecentPlayersCompleteDelegate_Handle

(
    const FOnQueryRecentPlayersComplete...
)

Public function Virtual

FDelegateHan...

 

AddOnRecentPlayersAddedDelegate_Handle

(
    const FOnRecentPlayersAddedDelegate...
)

Public function Virtual

FDelegateHan...

 

AddOnRejectInviteCompleteDelegate_Handle

(
    int32 LocalUserNum,
    const FOnRejectInviteCompleteDelega...
)

Public function Virtual

FDelegateHan...

 

AddOnUnblockedPlayerCompleteDelegate_Handle

(
    int32 LocalUserNum,
    const FOnUnblockedPlayerCompleteDel...
)

Public function Virtual

void

 

AddRecentPlayers

(
    const FUniqueNetId& UserId,
    const TArray< FReportPlayedWithUser...,
    const FString& ListName,
    const FOnAddRecentPlayersComplete&...
)

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

 

ClearOnBlockedPlayerCompleteDelegate_Handle

(
    int32 LocalUserNum,
    FDelegateHandle& Handle
)

Public function Virtual

void

 

ClearOnBlockedPlayerCompleteDelegates

(
    int32 LocalUserNum,
    void* Object
)

Public function Virtual

void

 

ClearOnBlockListChangeDelegate_Handle

(
    int32 LocalUserNum,
    FDelegateHandle& Handle
)

Public function Virtual

void

 

ClearOnBlockListChangeDelegates

(
    int32 LocalUserNum,
    void* Object
)

Public function Virtual

void

 

ClearOnDeleteFriendCompleteDelegate_Handle

(
    int32 LocalUserNum,
    FDelegateHandle& Handle
)

Public function Virtual

void

 

ClearOnDeleteFriendCompleteDelegates

(
    int32 LocalUserNum,
    void* Object
)

Public function Virtual

void

 

ClearOnFriendRemovedDelegate_Handle

(
    FDelegateHandle& Handle
)

Public function Virtual

void

 

ClearOnFriendRemovedDelegates

(
    void* Object
)

Public function Virtual

void

 

ClearOnFriendsChangeDelegate_Handle

(
    int32 LocalUserNum,
    FDelegateHandle& Handle
)

Public function Virtual

void

 

ClearOnFriendsChangeDelegates

(
    int32 LocalUserNum,
    void* Object
)

Public function Virtual

void

 

ClearOnInviteAbortedDelegate_Handle

(
    FDelegateHandle& Handle
)

Public function Virtual

void

 

ClearOnInviteAbortedDelegates

(
    void* Object
)

Public function Virtual

void

 

ClearOnInviteAcceptedDelegate_Handle

(
    FDelegateHandle& Handle
)

Public function Virtual

void

 

ClearOnInviteAcceptedDelegates

(
    void* Object
)

Public function Virtual

void

 

ClearOnInviteReceivedDelegate_Handle

(
    FDelegateHandle& Handle
)

Public function Virtual

void

 

ClearOnInviteReceivedDelegates

(
    void* Object
)

Public function Virtual

void

 

ClearOnInviteRejectedDelegate_Handle

(
    FDelegateHandle& Handle
)

Public function Virtual

void

 

ClearOnInviteRejectedDelegates

(
    void* Object
)

Public function Virtual

void

 

ClearOnOutgoingInviteSentDelegate_Handle

(
    int32 LocalUserNum,
    FDelegateHandle& Handle
)

Public function Virtual

void

 

ClearOnOutgoingInviteSentDelegates

(
    int32 LocalUserNum,
    void* Object
)

Public function Virtual

void

 

ClearOnQueryBlockedPlayersCompleteDelegate_Handle

(
    FDelegateHandle& Handle
)

Public function Virtual

void

 

ClearOnQueryBlockedPlayersCompleteDelegates

(
    void* Object
)

Public function Virtual

void

 

ClearOnQueryRecentPlayersCompleteDelegate_Handle

(
    FDelegateHandle& Handle
)

Public function Virtual

void

 

ClearOnQueryRecentPlayersCompleteDelegates

(
    void* Object
)

Public function Virtual

void

 

ClearOnRecentPlayersAddedDelegate_Handle

(
    FDelegateHandle& Handle
)

Public function Virtual

void

 

ClearOnRecentPlayersAddedDelegates

(
    void* Object
)

Public function Virtual

void

 

ClearOnRejectInviteCompleteDelegate_Handle

(
    int32 LocalUserNum,
    FDelegateHandle& Handle
)

Public function Virtual

void

 

ClearOnRejectInviteCompleteDelegates

(
    int32 LocalUserNum,
    void* Object
)

Public function Virtual

void

 

ClearOnUnblockedPlayerCompleteDelegate_Handle

(
    int32 LocalUserNum,
    FDelegateHandle& Handle
)

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 ...
)

Starts an async task that delete an alias from a friend.

Public function

bool

 

DeleteFriendsList

(
    int32 LocalUserNum,
    const FString& ListName,
    const FOnDeleteFriendsListComplete ...
)

Starts an async task that deletes the named friends list for the player

Public function Const

void

 

DumpBlockedPlayers()

Dump state information about blocked players

Public function Const

void

 

DumpRecentPlayers()

Dump state information about blocked players

Public function

bool

 

GetBlockedPlayers

(
    const FUniqueNetId& UserId,
    TArray< TSharedRef< FOnlineBlockedP...
)

Get the list of blocked players

Public function

TSharedPtr< ...

 

GetFriend

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

Get the cached friend entry if found

Public function Virtual

bool

 

GetFriendSettings

(
    const FUniqueNetId& UserId,
    TMap< FString, TSharedRef< FOnlineF...
)

Gets the cached information we have stored from a third party source

Public function

bool

 

GetFriendsList

(
    int32 LocalUserNum,
    const FString& ListName,
    TArray< TSharedRef< FOnlineFriend >...
)

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< FOnlineRecentPl...
)

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

 

QueryFriendSettings

(
    const FUniqueNetId& LocalUserId,
    FOnSettingsOperationComplete Delega...
)

Query the current friend settings

Public function Virtual

bool

 

QueryFriendSettings

(
    const FUniqueNetId& UserId,
    const FString& Source,
    const FOnQueryFriendSettingsComplet...
)

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& ...
)

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& Deleg...
)

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& D...
)

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 ...
)

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

 

TriggerOnFriendsChangeDelegates

(
    int32 LocalUserNum
)

Public function Virtual

void

 

TriggerOnInviteAbortedDelegates

(
    const FUniqueNetId& Param1,
    const FUniqueNetId& Param2
)

Public function Virtual

void

 

TriggerOnInviteAcceptedDelegates

(
    const FUniqueNetId& Param1,
    const FUniqueNetId& Param2
)

Public function Virtual

void

 

TriggerOnInviteReceivedDelegates

(
    const FUniqueNetId& Param1,
    const FUniqueNetId& Param2
)

Public function Virtual

void

 

TriggerOnInviteRejectedDelegates

(
    const FUniqueNetId& Param1,
    const FUniqueNetId& Param2
)

Public function Virtual

void

 

TriggerOnOutgoingInviteSentDelegates

(
    int32 LocalUserNum
)

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

 

TriggerOnRecentPlayersAddedDelegates

(
    const FUniqueNetId& Param1,
    const TArray< TSharedRef< FOnlineRe...
)

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

 

UpdateFriendSettings

(
    const FUniqueNetId& LocalUserId,
    const FFriendSettings& NewSettings,
    FOnSettingsOperationComplete Delega...
)

Update the current friend settings

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss