iOS
Android
Unity
REST Api
BDArenaLeaderboardsDelegate

Availability : ver 1.0 and later

Declared in : BDArenaLeaderboardsDelegate.h

Sample code : -

Overview

The delegates of the BDArenaLeaderboards object must adopt the BDArenaLeaderboardsDelegate protocol in order to be notified about the results of the operations of publication of scores and for retrieving of the leaderboards associated with the application.

Tasks

Retrieving leaderboards

- arenaLeaderboards:getLeaderboardsDidFailWithError:

- arenaLeaderboards:getLeaderboardsSuccessfullyCompletedWithArray:

 

Posting and setting score to leaderboards

- arenaLeaderboards:setScoreToLeaderboardWithId:didFailWithError:

- arenaLeaderboards:setScoreSuccessfullyCompletedToLeaderboardWithId: deprecated in SDK 2.5.3

- arenaLeaderboards:setScoreSuccessfullyCompletedToLeaderboardWithId:withScore:withPlacement:

- arenaLeaderboards:setHighscoreToLeaderboardWithId:didFailWithError:

arenaLeaderboards:setHighscoreSuccessfullyCompletedToLeaderboardWithId:
        withOldHighscore:withPlacement:didOverwritePreviousScore:

- arenaLeaderboards:postScoreToLeaderboardWithId:didFailWithError:

- arenaLeaderboards:postScoreSuccessfullyCompletedToLeaderboardWithId: deprecated in SDK 2.5.3

- arenaLeaderboards:postScoreSuccessfullyCompletedToLeaderboardWithId:withPostedScore:
        withNewScore:withPlacement:

 

Retrieving scores for leaderboards

- arenaLeaderboards:getScoreForLeaderboardWithId:didFailWithError:

- arenaLeaderboards:getScoreForLeaderboardWithId:successfullyCompletedWithArray:

 

Retrieving scores for players

- arenaLeaderboards:getScoreForPlayerWithAuid:inLeaderboardWithId:didFailWithError:

- arenaLeaderboards:getScoreForPlayerWithAuid:successfullyCompletedWithScore:
        withPlacement:withPlayerData:inLeaderboardWithId:

 

 


 

 

 

arenaLeaderboards:getLeaderboardsDidFailWithError:

 

Notifies that the request for obtaining the list of the leaderboards did fail.

 

- (void) arenaLeaderboards:(BDArenaLeaderboards*)leaderboards

        getLeaderboardsDidFailWithError:(NSError*)error;

 

Parameters

leaderboards

    The unique instance of BDArenaLeaderboards.

error

    An NSError object containing the specific error that occurred.

    For more information about errors, check out the Errors Map section.

 

Availability

available in SDK ver 1.0 and later

 

Declared in

BDArenaLeaderboardsDelegate.h

 

 

 

arenaLeaderboards:getLeaderboardsSuccessfullyCompletedWithArray:

 

Notifies that the request for obtaining the list of the leaderboards did succeed.

 

- (void) arenaLeaderboards:(BDArenaLeaderboards*)leaderboards

        getLeaderboardsSuccessfullyCompletedWithArray:(NSArray*)leaderboardsArray;

 

Parameters

leaderboards

    The unique instance of BDArenaLeaderboards.

leaderboardsArray

    An Array of BDArenaLeaderboardData objects containing information

    about the available leaderboards.

 

Availability

available in SDK ver 1.0 and later

 

Declared in

BDArenaLeaderboardsDelegate.h

 

 

 

arenaLeaderboards:setScoreToLeaderboardWithId:didFailWithError:

 

Notifies that the registration of a new score for the local player did fail.

 

- (void) arenaLeaderboards:(BDArenaLeaderboards*)leaderboards

        setScoreToLeaderboardWithId:(NSInteger)leaderboardId

        didFailWithError:(NSError*)error;

 

Parameters

leaderboards

    The unique instance of BDArenaLeaderboards.

leaderboardId

    The leaderboard identifier.

error

    An NSError object containing the specific error that occurred.

    For more information about errors, check out the Errors Map section.

 

Availability

available in SDK ver 2.2 and later

 

Declared in

BDArenaLeaderboardsDelegate.h

 

 

 

arenaLeaderboards:setScoreSuccessfullyCompletedToLeaderboardWithId:

 

Notifies that the registration of a new score for the local player did succeed.

 

- (void) arenaLeaderboards:(BDArenaLeaderboards*)leaderboards

        setScoreSuccessfullyCompletedToLeaderboardWithId:(NSInteger)leaderboardId;

 

Parameters

leaderboards

    The unique instance of BDArenaLeaderboards.

leaderboardId

    The leaderboard identifier.

 

Discussion

This method is deprecated. Use 

arenaLeaderboards:setScoreSuccessfullyCompletedToLeaderboardWithId:withScore:withPlacement: 

instead.

If the developer runs the application in SANDBOX environment,

the score posted is not actually saved and the score of the local player

does not change even if this method is called by the SDK.

 

Availability

available in SDK ver 2.2 and later

 

Declared in

BDArenaLeaderboardsDelegate.h

 

 

 

arenaLeaderboards:setScoreSuccessfullyCompletedToLeaderboardWithId:

        withScore:withPlacement:

 

Notifies that the registration of a new score for the local player did succeed.

 

- (void) arenaLeaderboards:(BDArenaLeaderboards*)leaderboards

        setScoreSuccessfullyCompletedToLeaderboardWithId:(NSInteger)leaderboardId

        withScore:(NSInteger)score

        withPlacement:(NSInteger)placement;

 

Parameters

leaderboards

    The unique instance of BDArenaLeaderboards.

leaderboardId

    The leaderboard identifier.

score

    The new score for the local player.

placement

    The placement of the player in the leaderboard.

 

Discussion

If the developer runs the application in SANDBOX environment,

the score posted is not actually saved and the score of the local player

does not change even if this method is called by the SDK.

 

Availability

available in SDK ver 2.5.3 and later

 

Declared in

BDArenaLeaderboardsDelegate.h

 

 

 

arenaLeaderboards:setHighscoreToLeaderboardWithId:didFailWithError:

 

Notifies that the registration of a new high score for the local player did fail.

 

- (void) arenaLeaderboards:(BDArenaLeaderboards*)leaderboards

        setHighscoreToLeaderboardWithId:(NSInteger)leaderboardId

        didFailWithError:(NSError*)error;

 

Parameters

leaderboards

    The unique instance of BDArenaLeaderboards.

leaderboardId

    The leaderboard identifier.

error

    An NSError object containing the specific error that occurred.

    For more information about errors, check out the Errors Map section.

 

Availability

available in SDK ver 2.5.3 and later

 

Declared in

BDArenaLeaderboardsDelegate.h

 

 

 

 

arenaLeaderboards:setHighscoreSuccessfullyCompletedToLeaderboardWithId:

        withOldHighscore:withScore:withPlacement:

        didOverwritePreviousScore:

 

Notifies that the registration of a new high score for the local player did succeed.

 

- (void) arenaLeaderboards:(BDArenaLeaderboards*)leaderboards

        setHighscoreSuccessfullyCompletedToLeaderboardWithId:(NSInteger)leaderboardId
        withOldHighscore:(NSInteger)oldHighscore
        withScore:(NSInteger)score
        withPlacement:(NSInteger)placement
        didOverwritePreviousScore:(BOOL)didOverwrite;

 

Parameters

leaderboards

    The unique instance of BDArenaLeaderboards.

leaderboardId

    The leaderboard identifier.

oldHighscore

    The high score value previously registered.

score

    The score sent.

placement

    The new placement of the local player in the leaderboard.

didOverwrite

    A boolean value that indicates whether the new score overwrote the previous highscore.

 

Availability

available in SDK ver 2.5.3 and later

 

Declared in

BDArenaLeaderboardsDelegate.h

 

 

 

arenaLeaderboards:postScoreToLeaderboardWithId:didFailWithError:

 

Notifies that the registration of a new score for the local player did fail.

 

- (void) arenaLeaderboards:(BDArenaLeaderboards*)leaderboards

        postScoreToLeaderboardWithId:(NSInteger)leaderboardId

        didFailWithError:(NSError*)error;

 

Parameters

leaderboards

    The unique instance of BDArenaLeaderboards.

leaderboardId

    The leaderboard identifier.

error

    An NSError object containing the specific error that occurred.

    For more information about errors, check out the Errors Map section.

 

Availability

available in SDK ver 1.0 and later

 

Declared in

BDArenaLeaderboardsDelegate.h

 

 

 

arenaLeaderboards:postScoreSuccessfullyCompletedToLeaderboardWithId:

 

Notifies that the registration of a new score for the local player did succeed.

 

- (void) arenaLeaderboards:(BDArenaLeaderboards*)leaderboards

        postScoreSuccessfullyCompletedToLeaderboardWithId:(NSInteger)leaderboardId;

 

Parameters

leaderboards

    The unique instance of BDArenaLeaderboards.

leaderboardId

    The leaderboard identifier.

 

Discussion

This method is deprecated. Use 

arenaLeaderboards:postScoreSuccessfullyCompletedToLeaderboardWithId:
withPostedScore:withNewScore:withPlacement:

instead.

If the developer runs the application in SANDBOX environment,

the score posted is not actually saved and the score of the local player

does not change even if this method is called by the SDK.

 

Availability

available in SDK ver 1.0 and later

 

Declared in

BDArenaLeaderboardsDelegate.h

 

 

 

arenaLeaderboards:postScoreSuccessfullyCompletedToLeaderboardWithId:

        withPostedScore:withNewScore:withPlacement:

 

Notifies that the registration of a new score for the local player did succeed.

 

- (void) arenaLeaderboards:(BDArenaLeaderboards*)leaderboards

        postScoreSuccessfullyCompletedToLeaderboardWithId:(NSInteger)leaderboardId 

        withPostedScore:(NSInteger)postedScore 

        withNewScore:(NSInteger)newScore 

        withPlacement:(NSInteger)placement;

 

Parameters

leaderboards

    The unique instance of BDArenaLeaderboards.

leaderboardId

    The leaderboard identifier.

postedScore

    The score sent.

newScore

    The new score registered for the local player.

placement

    The placement of the player in the leaderboard.

 

Discussion

If the developer runs the application in SANDBOX environment,

the score posted is not actually saved and the score of the local player

does not change even if this method is called by the SDK.

 

Availability

available in SDK ver 2.5.3 and later

 

Declared in

BDArenaLeaderboardsDelegate.h

 

 

 

arenaLeaderboards:getScoreForLeaderboardWithId:didFailWithError:

 

Notifies that the request for retrieving the scores for a specific leaderboard did fail.

 

- (void) arenaLeaderboards:(BDArenaLeaderboards*)leaderboards

        getScoreForLeaderboardWithId:(NSInteger)leaderboardId

        didFailWithError:(NSError*)error;

 

Parameters

leaderboards

    The unique instance of BDArenaLeaderboards.

leaderboardId

    The leaderboard identifier.

error

    An NSError object containing the specific error that occurred.

    For more information about errors, check out the Errors Map section.

 

Availability

available in SDK ver 1.0 and later

 

Declared in

BDArenaLeaderboardsDelegate.h

 

 

 

 

arenaLeaderboards:getScoreForLeaderboardWithId:

        successfullyCompletedWithArray:

 

Retrieves the list of scores for a specific leaderboard.

 

- (void) arenaLeaderboards:(BDArenaLeaderboards*)leaderboards

        getScoreForLeaderboardWithId:(NSInteger)leaderboardId

        successfullyCompletedWithArray:(NSArray*)scoresArray; 

 

Parameters

leaderboards

    The unique instance of BDArenaLeaderboards.

leaderboardId

    The leaderboard identifier.

scoresArray

    An Array of BDArenaScoreData objects.

 

Availability

available in SDK ver 1.0 and later

 

Declared in

BDArenaLeaderboardsDelegate.h

 

 

 

arenaLeaderboards:getScoreForPlayerWithAuid:

        inLeaderboardWithId:didFailWithError:

 

Informs that the request for retrieving the score for a specific player

in a specific leaderboard did fail.

 

- (void) arenaLeaderboards:(BDArenaLeaderboards*)leaderboards

        getScoreForPlayerWithAuid:(NSInteger)auid

        inLeaderboardWithId:(NSInteger)leaderboardId

        didFailWithError:(NSError*)error;

 

Parameters

leaderboards

    The unique instance of BDArenaLeaderboards.

auid

    The Arena Daemon Unique Id (auid) of the requested player.

leaderboardId

    The leaderboard identifier.

error

    An NSError object containing the specific error that occurred.

    For more information about errors, check out the Errors Map section.

 

Availability

available in SDK ver 1.0 and later

 

Declared in

BDArenaLeaderboardsDelegate.h

 

 

 

 

arenaLeaderboards:getScoreForPlayerWithAuid:

        successfullyCompletedWithScore:withPlacement:

        withPlayerData:inLeaderboardWithId:

 

Informs that the request for retrieving the score for a specific player

in a specific leaderboard did fail.

 

- (void) arenaLeaderboards:(BDArenaLeaderboards*)leaderboards

        getScoreForPlayerWithAuid:(NSInteger)auid

        successfullyCompletedWithScore:(NSInteger)score

        withPlacement:(NSInteger)placement

        withPlayerData:(BDArenaPlayerData*)playerData

        inLeaderboardWithId:(NSInteger)leaderboardId;

 

Parameters

leaderboards

    The unique instance of BDArenaLeaderboards.

auid

    The Arena Daemon Unique Id (auid) of the requested player.

score

    The actual score obtained by the requested player

placement

    The placement of the player in the leaderboard.

playerData

    A BDArenaPlayerData object filled with the information of the requested player.

leaderboardId

    The leaderboard identifier.

 

Availability

available in SDK ver 1.0 and later

 

Declared in

BDArenaLeaderboardsDelegate.h