FOnlineFriendsOmni

Description

Implementation of the IOnlineFriends interface for the OnlineSubsystem.

See also

IOnlineFriends

#include <OnlineFriendsOmni.h>

Inherits IOnlineFriends.

Public Member Functions
virtual bool	ReadFriendsList (int32 LocalUserNum, const FString &ListName, const FOnReadFriendsListComplete &Delegate) override
	Starts an async task that reads the named friends list for the player.
virtual bool	GetFriendsList (int32 LocalUserNum, const FString &ListName, TArray< TSharedRef< FOnlineFriend > > &OutFriends) override
	Copies the list of friends for the player previously retrieved from the online service.
virtual TSharedPtr< FOnlineFriend >	GetFriend (int32 LocalUserNum, const FUniqueNetId &FriendId, const FString &ListName) override
	Get the cached friend entry if found.
virtual bool	IsFriend (int32 LocalUserNum, const FUniqueNetId &FriendId, const FString &ListName) override
	Checks that a unique player id is part of the specified user's friends list.
virtual bool	DeleteFriendsList (int32 LocalUserNum, const FString &ListName, const FOnDeleteFriendsListComplete &Delegate) override
	Not Supported.
virtual bool	SendInvite (int32 LocalUserNum, const FUniqueNetId &FriendId, const FString &ListName, const FOnSendInviteComplete &Delegate) override
	Not Supported.
virtual bool	AcceptInvite (int32 LocalUserNum, const FUniqueNetId &FriendId, const FString &ListName, const FOnAcceptInviteComplete &Delegate) override
	Not Supported.
virtual bool	RejectInvite (int32 LocalUserNum, const FUniqueNetId &FriendId, const FString &ListName) override
	Not Supported.
virtual void	SetFriendAlias (int32 LocalUserNum, const FUniqueNetId &FriendId, const FString &ListName, const FString &Alias, const FOnSetFriendAliasComplete &Delegate) override
	Not Supported.
virtual void	DeleteFriendAlias (int32 LocalUserNum, const FUniqueNetId &FriendId, const FString &ListName, const FOnDeleteFriendAliasComplete &Delegate) override
	Not Supported.
virtual bool	DeleteFriend (int32 LocalUserNum, const FUniqueNetId &FriendId, const FString &ListName) override
	Not Supported.
virtual bool	QueryRecentPlayers (const FUniqueNetId &UserId, const FString &Namespace) override
	Not Supported.
virtual bool	GetRecentPlayers (const FUniqueNetId &UserId, const FString &Namespace, TArray< TSharedRef< FOnlineRecentPlayer > > &OutRecentPlayers) override
	Not Supported.
virtual void	DumpRecentPlayers () const override
	Not Supported.
virtual bool	BlockPlayer (int32 LocalUserNum, const FUniqueNetId &PlayerId) override
	Not Supported.
virtual bool	UnblockPlayer (int32 LocalUserNum, const FUniqueNetId &PlayerId) override
	Not Supported.
virtual bool	QueryBlockedPlayers (const FUniqueNetId &UserId) override
	Not Supported.
virtual bool	GetBlockedPlayers (const FUniqueNetId &UserId, TArray< TSharedRef< FOnlineBlockedPlayer > > &OutBlockedPlayers) override
	Not Supported.
virtual void	DumpBlockedPlayers () const override
	Not Supported.

Methods

GetFriend()

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

overridevirtual

Get the cached friend entry if found.

Parameters

LocalUserNum	the user to read the friends list of
FriendId	user id of the desired friend
ListName	name of the friends list to read

Returns

Friend data or null ptr if not found

GetFriendsList()

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

overridevirtual

Copies the list of friends for the player previously retrieved from the online service.

Parameters

LocalUserNum	the user to read the friends list of
ListName	name of the friends list to read
OutFriends	[out] array that receives the copied data

Returns

true if friends list was found

IsFriend()

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

overridevirtual

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

Parameters

LocalUserNum	the controller number of the associated user that made the request
FriendId	the id of the player being checked for friendship
ListName	name of the friends list to read

Returns

true if friends list was found and the friend was valid

ReadFriendsList()

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

overridevirtual

Starts an async task that reads the named friends list for the player.

Parameters

LocalUserNum	the user to read the friends list of
ListName	name of the friends list to read
Delegate	Delegate to execute when friends list is read

Returns

true if the read request was started successfully, false otherwise