ILeaderboardsRetrieveListener Class Reference

Listener for the event of retrieving definitions of leaderboards. More...

#include <IStats.h>

Inheritance diagram for ILeaderboardsRetrieveListener:

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

Public Member Functions
virtual void	OnLeaderboardsRetrieveSuccess ()=0
	Notification for the event of a success in retrieving definitions of leaderboards. More...
virtual void	OnLeaderboardsRetrieveFailure (FailureReason failureReason)=0
	Notification for the event of a failure in retrieving definitions of leaderboards. More...

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

Detailed Description

Listener for the event of retrieving definitions of leaderboards.

Member Enumeration Documentation

FailureReason

enum FailureReason

The reason of a failure in retrieving definitions of leaderboards.

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

Member Function Documentation

OnLeaderboardsRetrieveFailure()

virtual void OnLeaderboardsRetrieveFailure ( FailureReason  failureReason )

pure virtual

Notification for the event of a failure in retrieving definitions of leaderboards.

Parameters

[in]

failureReason

The cause of the failure.

OnLeaderboardsRetrieveSuccess()

virtual void OnLeaderboardsRetrieveSuccess ( )

pure virtual

Notification for the event of a success in retrieving definitions of leaderboards.

In order to read metadata of retrieved leaderboards, 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().