Listener for the event of retrieving requested entries of a leaderboard. More...

#include <IStats.h>

Inheritance diagram for ILeaderboardEntriesRetrieveListener:

Public Types
enum	FailureReason { FAILURE_REASON_UNDEFINED , FAILURE_REASON_NOT_FOUND , FAILURE_REASON_CONNECTION_FAILURE }
	The reason of a failure in retrieving requested entries of a leaderboard. More...

Public Member Functions
virtual void	OnLeaderboardEntriesRetrieveSuccess (const char *name, uint32_t entryCount)=0
	Notification for the event of a success in retrieving requested entries of a leaderboard. More...

virtual void	OnLeaderboardEntriesRetrieveFailure (const char *name, FailureReason failureReason)=0
	Notification for the event of a failure in retrieving requested entries of a leaderboard. More...

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

Detailed Description

Listener for the event of retrieving requested entries of a leaderboard.

Member Enumeration Documentation

The reason of a failure in retrieving requested entries of a leaderboard.

Enumerator
FAILURE_REASON_UNDEFINED	Unspecified error.
FAILURE_REASON_NOT_FOUND	Could not find any entries for specified search criteria.
FAILURE_REASON_CONNECTION_FAILURE	Unable to communicate with backend services.

virtual void OnLeaderboardEntriesRetrieveFailure	(	const char *	name,
		FailureReason	failureReason
	)

pure virtual

Notification for the event of a failure in retrieving requested entries of a leaderboard.

Parameters

[in]	name	The name of the leaderboard.
[in]	failureReason	The cause of the failure.

virtual void OnLeaderboardEntriesRetrieveSuccess	(	const char *	name,
		uint32_t	entryCount
	)

pure virtual

Notification for the event of a success in retrieving requested entries of a leaderboard.

In order to read subsequent entries, call IStats::GetRequestedLeaderboardEntry().

Parameters

[in]	name	The name of the leaderboard.
[in]	entryCount	The number of entries that were retrieved.