com.ibasco.agql.protocols.supercell.coc.webapi.interfaces

Class CocLeagues

java.lang.Object

com.ibasco.agql.core.AbstractWebApiInterface<CocWebApiClient,CocWebApiRequest,CocWebApiResponse>

com.ibasco.agql.protocols.supercell.coc.webapi.CocWebApiInterface

com.ibasco.agql.protocols.supercell.coc.webapi.interfaces.CocLeagues

Deprecated.

@Deprecated
 @ApiStatus.ScheduledForRemoval
public class CocLeagues
extends CocWebApiInterface

A Web API Implementation of the League interface

Author:

Rafael Luis Ibasco

See Also:

Clash of Clans API - Leagues

Field Summary

Fields inherited from class com.ibasco.agql.core.AbstractWebApiInterface

VERSION_1, VERSION_2, VERSION_3

Constructor Summary

Constructors

Constructor and Description
CocLeagues(CocWebApiClient client) Deprecated. Default Constructor

Method Summary

Modifier and Type	Method and Description
protected void	configureBuilder(com.google.gson.GsonBuilder builder) Deprecated. Override this method if you need to perform additional configurations against the builder (e.g.
CompletableFuture<CocLeague>	getLeagueInfo(int leagueId) Deprecated. Get league information
CompletableFuture<List<CocLeague>>	getLeagueList() Deprecated. Get list of leagues
CompletableFuture<List<CocLeague>>	getLeagueList(int limit) Deprecated. Get list of leagues
CompletableFuture<List<CocLeague>>	getLeagueList(int limit, int before, int after) Deprecated. Get list of leagues
CompletableFuture<List<CocLeagueSeason>>	getLeagueSeasons(int leagueId) Deprecated. Get league seasons.
CompletableFuture<List<CocLeagueSeason>>	getLeagueSeasons(int leagueId, int limit) Deprecated. Get league seasons.
CompletableFuture<List<CocLeagueSeason>>	getLeagueSeasons(int leagueId, int limit, int before, int after) Deprecated. Get league seasons.
CompletableFuture<List<CocPlayerRankInfo>>	getLeagueSeasonsPlayerRankings(int leagueId, String seasonId) Deprecated. Get league season player rankings.
CompletableFuture<List<CocPlayerRankInfo>>	getLeagueSeasonsPlayerRankings(int leagueId, String seasonId, int limit) Deprecated. Get league season player rankings.
CompletableFuture<List<CocPlayerRankInfo>>	getLeagueSeasonsPlayerRankings(int leagueId, String seasonId, int limit, int before, int after) Deprecated. Get league season player rankings.

Methods inherited from class com.ibasco.agql.protocols.supercell.coc.webapi.CocWebApiInterface

handleError

Methods inherited from class com.ibasco.agql.core.AbstractWebApiInterface

asCollectionOf, asListOf, builder, fromJson, fromJson, sendRequest

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CocLeagues

public CocLeagues(CocWebApiClient client)

Deprecated.

Default Constructor

Parameters:

client - A CocWebApiClient instance

Method Detail

configureBuilder

protected void configureBuilder(com.google.gson.GsonBuilder builder)

Deprecated.

Override this method if you need to perform additional configurations against the builder (e.g. Register custom deserializers)

Overrides:

configureBuilder in class AbstractWebApiInterface<CocWebApiClient,CocWebApiRequest,CocWebApiResponse>

Parameters:

builder - A GsonBuilder instance that will be accessed and configured by a concrete AbstractWebApiInterface implementation

getLeagueList

public CompletableFuture<List<CocLeague>> getLeagueList()

Deprecated.

Get list of leagues

Returns:

A CompletableFuture which contains a future result for a List of CocLeague

getLeagueList

public CompletableFuture<List<CocLeague>> getLeagueList(int limit)

Deprecated.

Get list of leagues

Parameters:

limit - An Integer limiting the number of records returned

Returns:

A CompletableFuture which contains a future result for a List of CocLeague

getLeagueList

public CompletableFuture<List<CocLeague>> getLeagueList(int limit,
                                                        int before,
                                                        int after)

Deprecated.

Get list of leagues

Parameters:

limit - An Integer limiting the number of records returned

before - (optional) An Integer that indicates to return only items that occur before this marker. Before marker can be found from the response, inside the 'paging' property. Note that only after or before can be specified for a request, not both. Otherwise use -1 to disregard.

after - (optional) An Integer that indicates to return only items that occur after this marker. After marker can be found from the response, inside the 'paging' property. Note that only after or before can be specified for a request, not both. Otherwise use -1 to disregard.

Returns:

A CompletableFuture which contains a future result for a List of CocLeague

getLeagueInfo

public CompletableFuture<CocLeague> getLeagueInfo(int leagueId)

Deprecated.

Get league information

Parameters:

leagueId - An Integer representing a valid Clash of Clans League Id

Returns:

A CompletableFuture containing a future result for CocLeague

getLeagueSeasons

public CompletableFuture<List<CocLeagueSeason>> getLeagueSeasons(int leagueId)

Deprecated.

Get league seasons. Note that league season information is available only for Legend League.

Parameters:

leagueId - An Integer representing a valid Clash of Clans League Id

Returns:

A CompletableFuture containing a future result for a List of CocLeagueSeason

getLeagueSeasons

public CompletableFuture<List<CocLeagueSeason>> getLeagueSeasons(int leagueId,
                                                                 int limit)

Deprecated.

Get league seasons. Note that league season information is available only for Legend League.

Parameters:

leagueId - An Integer representing a valid Clash of Clans League Id

limit - An Integer limiting the number of records returned

Returns:

A CompletableFuture containing a future result for a List of CocLeagueSeason

getLeagueSeasons

public CompletableFuture<List<CocLeagueSeason>> getLeagueSeasons(int leagueId,
                                                                 int limit,
                                                                 int before,
                                                                 int after)

Deprecated.

Get league seasons. Note that league season information is available only for Legend League.

Parameters:

leagueId - An Integer representing a valid Clash of Clans League Id

limit - An Integer limiting the number of records returned

before - (optional) An Integer that indicates to return only items that occur before this marker. Before marker can be found from the response, inside the 'paging' property. Note that only after or before can be specified for a request, not both. Otherwise use -1 to disregard.

after - (optional) An Integer that indicates to return only items that occur after this marker. After marker can be found from the response, inside the 'paging' property. Note that only after or before can be specified for a request, not both. Otherwise use -1 to disregard.

Returns:

A CompletableFuture containing a future result for a List of CocLeagueSeason

getLeagueSeasonsPlayerRankings

public CompletableFuture<List<CocPlayerRankInfo>> getLeagueSeasonsPlayerRankings(int leagueId,
                                                                                 String seasonId)

Deprecated.

Get league season player rankings. Note that league season information is available only for Legend League.

Parameters:

leagueId - An Integer representing a valid Clash of Clans League Id

seasonId - An Integer representing a valid Clash of Clans Season Id

Returns:

A CompletableFuture containing a future result for a List of CocPlayerRankInfo

See Also:

getLeagueSeasons(int)

getLeagueSeasonsPlayerRankings

public CompletableFuture<List<CocPlayerRankInfo>> getLeagueSeasonsPlayerRankings(int leagueId,
                                                                                 String seasonId,
                                                                                 int limit)

Deprecated.

Get league season player rankings. Note that league season information is available only for Legend League.

Parameters:

leagueId - An Integer representing a valid Clash of Clans League Id

seasonId - An Integer representing a valid Clash of Clans Season Id

limit - An Integer limiting the number of records returned

Returns:

A CompletableFuture containing a future result for a List of CocPlayerRankInfo

See Also:

getLeagueSeasons(int)

getLeagueSeasonsPlayerRankings

public CompletableFuture<List<CocPlayerRankInfo>> getLeagueSeasonsPlayerRankings(int leagueId,
                                                                                 String seasonId,
                                                                                 int limit,
                                                                                 int before,
                                                                                 int after)

Deprecated.

Get league season player rankings. Note that league season information is available only for Legend League.

Parameters:

leagueId - An Integer representing a valid Clash of Clans League Id

seasonId - An Integer representing a valid Clash of Clans Season Id

limit - An Integer limiting the number of records returned

before - (optional) An Integer that indicates to return only items that occur before this marker. Before marker can be found from the response, inside the 'paging' property. Note that only after or before can be specified for a request, not both. Otherwise use -1 to disregard.

after - (optional) An Integer that indicates to return only items that occur after this marker. After marker can be found from the response, inside the 'paging' property. Note that only after or before can be specified for a request, not both. Otherwise use -1 to disregard.

Returns:

A CompletableFuture containing a future result for a List of CocPlayerRankInfo

See Also:

getLeagueSeasons(int)