IFriendListListener Class Reference

Listener for the event of retrieving requested list of friends. More...

#include <IFriends.h>

Inheritance diagram for IFriendListListener:

Public Types
enum	FailureReason { FAILURE_REASON_UNDEFINED , FAILURE_REASON_CONNECTION_FAILURE }
	The reason of a failure in retrieving the user's list of friends. More...

Public Member Functions
virtual void	OnFriendListRetrieveSuccess ()=0
	Notification for the event of a success in retrieving the user's list of friends. More...
virtual void	OnFriendListRetrieveFailure (FailureReason failureReason)=0
	Notification for the event of a failure in retrieving the user's list of friends. More...

Additional Inherited Members
Static Public Member Functions inherited from GalaxyTypeAwareListener< FRIEND_LIST_RETRIEVE >
static ListenerType	GetListenerType ()
	Returns the type of the listener. More...

Detailed Description

Listener for the event of retrieving requested list of friends.

Member Enumeration Documentation

FailureReason

enum FailureReason

The reason of a failure in retrieving the user's list of friends.

Enumerator
FAILURE_REASON_UNDEFINED	Unspecified error.
FAILURE_REASON_CONNECTION_FAILURE	Unable to communicate with backend services.

Member Function Documentation

OnFriendListRetrieveFailure()

virtual void OnFriendListRetrieveFailure ( FailureReason  failureReason )

pure virtual

Notification for the event of a failure in retrieving the user's list of friends.

Parameters

[in]

failureReason

The cause of the failure.

OnFriendListRetrieveSuccess()

virtual void OnFriendListRetrieveSuccess ( )

pure virtual

Notification for the event of a success in retrieving the user's list of friends.

In order to read subsequent friend IDs, call IFriends::GetFriendCount() and IFriends::GetFriendByIndex().