FOnlineFriendsPico Class Reference

OnlineFriendsPico class inherited from IOnlineFriends(Unreal Engine). More...

#include <OnlineFriendsInterfacePico.h>

Public Member Functions
virtual bool	ReadFriendsList (int32 LocalUserNum, const FString &ListName, const FOnReadFriendsListComplete &Delegate=FOnReadFriendsListComplete()) override
	Starts an async task that reads the named friend list for a user. More...
virtual bool	GetFriendsList (int32 LocalUserNum, const FString &ListName, TArray< TSharedRef< FOnlineFriend > > &OutFriends) override
	Gets a list of friends previously retrieved from the online service for a user. More...
virtual TSharedPtr< FOnlineFriend >	GetFriend (int32 LocalUserNum, const FUniqueNetId &FriendId, const FString &ListName) override
	Gets the cached friend entry if found. More...
virtual bool	IsFriend (int32 LocalUserNum, const FUniqueNetId &FriendId, const FString &ListName) override
	Checks whether someone is the friend of a user. More...

Detailed Description

OnlineFriendsPico class inherited from IOnlineFriends(Unreal Engine).

Member Function Documentation

GetFriend()

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

overridevirtual

Gets the cached friend entry if found.

Parameters

LocalUserNum	The controller number of the user to get the cached friend entry for.
FriendId	The ID of the user (someone) being checked for friendship.
ListName	The name of the friends list to read.

Returns

FOnlineFriend:A FOnlineFriend class.

GetFriendsList()

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

overridevirtual

Gets a list of friends previously retrieved from the online service for a user.

Parameters

LocalUserNum	The controller number of the user to get the friend list for.
ListName	The name of the friends list to read.
OutFriends	The [out] array that receives the copied data.

Returns

Bool:

• true: the friend list has been found
• false: otherwise

IsFriend()

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

overridevirtual

Checks whether someone is the friend of a user.

Parameters

LocalUserNum	The controller number of the user that made the request.
FriendId	The ID of the user (someone) being checked for friendship.
ListName	The name of the friends list to read.

Returns

Bool:

• true: the friend list has been found and the friend is valid
• false: otherwise

ReadFriendsList()

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

overridevirtual

Starts an async task that reads the named friend list for a user.

Parameters

LocalUserNum	The controller number of the user to read the friend list for.
ListName	The name of the friend list to read.
Delegate	Delegate will broadcast after function execution.

Returns

Bool:

• true: success
• false: failure