ILeaderboardRetrieveListener Class Reference

Listener for the event of retrieving definition of a leaderboard. More...

#include <IStats.h>

Inheritance diagram for ILeaderboardRetrieveListener:

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

Public Member Functions
virtual void	OnLeaderboardRetrieveSuccess (const char *name)=0
	Notification for the event of a success in retrieving definition of a leaderboard. More...
virtual void	OnLeaderboardRetrieveFailure (const char *name, FailureReason failureReason)=0
	Notification for the event of a failure in retrieving definition of a leaderboard. More...

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

Detailed Description

Listener for the event of retrieving definition of a leaderboard.

Member Enumeration Documentation

FailureReason

enum FailureReason

The reason of a failure in retrieving definition of a leaderboard.

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

Member Function Documentation

OnLeaderboardRetrieveFailure()

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

pure virtual

Notification for the event of a failure in retrieving definition of a leaderboard.

Parameters

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

OnLeaderboardRetrieveSuccess()

virtual void OnLeaderboardRetrieveSuccess ( const char *  name )

pure virtual

Notification for the event of a success in retrieving definition of a leaderboard.

In order to read metadata of the retrieved leaderboard, call IStats::GetLeaderboardDisplayName(), IStats::GetLeaderboardSortMethod(), or IStats::GetLeaderboardDisplayType().

In order to read entries, retrieve some first by calling IStats::RequestLeaderboardEntriesGlobal(), IStats::RequestLeaderboardEntriesAroundUser(), or IStats::RequestLeaderboardEntriesForUsers().

Parameters

[in]

name

The name of the leaderboard.