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

Class CocLocations

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.CocLocations

Deprecated.

@Deprecated
 @ApiStatus.ScheduledForRemoval
public class CocLocations
extends CocWebApiInterface

A Web API Implementation of the Location interface. Contains methods for clan/player inquiries based on location.

Author:

Rafael Luis Ibasco

See Also:

Clash of Clans API - Locations

Field Summary

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

VERSION_1, VERSION_2, VERSION_3

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
CompletableFuture<List<CocClanRankInfo>>	getClanRankingsFromLocation(int locationId) Deprecated. Get clan rankings for a specific location
CompletableFuture<List<CocClanRankInfo>>	getClanRankingsFromLocation(int locationId, int limit) Deprecated. Get clan rankings for a specific location
CompletableFuture<List<CocClanRankInfo>>	getClanRankingsFromLocation(int locationId, int limit, int before, int after) Deprecated. Get clan rankings for a specific location
CompletableFuture<CocLocation>	getLocationInfo(int locationId) Deprecated. Get information about specific location
CompletableFuture<List<CocLocation>>	getLocations() Deprecated. List all available locations
CompletableFuture<List<CocLocation>>	getLocations(int limit) Deprecated. List all available locations
CompletableFuture<List<CocLocation>>	getLocations(int limit, int before, int after) Deprecated. List all available locations
CompletableFuture<List<CocPlayerRankInfo>>	getPlayerRankingsFromLocation(int locationId) Deprecated. Get player rankings for a specific location
CompletableFuture<List<CocPlayerRankInfo>>	getPlayerRankingsFromLocation(int locationId, int limit) Deprecated. Get player rankings for a specific location
CompletableFuture<List<CocPlayerRankInfo>>	getPlayerRankingsFromLocation(int locationId, int limit, int before, int after) Deprecated. Get player rankings for a specific location

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, configureBuilder, fromJson, fromJson, sendRequest

Methods inherited from class java.lang.Object

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

Constructor Detail

CocLocations

public CocLocations(CocWebApiClient client)

Deprecated.

Default Constructor

Parameters:

client - A CocWebApiClient instance

Method Detail

getLocations

public CompletableFuture<List<CocLocation>> getLocations()

Deprecated.

List all available locations

Returns:

A CompletableFuture containing a future result for a List of CocLocation

getLocations

public CompletableFuture<List<CocLocation>> getLocations(int limit,
                                                         int before,
                                                         int after)

Deprecated.

List all available locations

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 containing a future result for a List of CocLocation

getLocations

public CompletableFuture<List<CocLocation>> getLocations(int limit)

Deprecated.

List all available locations

Parameters:

limit - An Integer limiting the number of records returned

Returns:

A CompletableFuture containing a future result for a List of CocLocation

getLocationInfo

public CompletableFuture<CocLocation> getLocationInfo(int locationId)

Deprecated.

Get information about specific location

Parameters:

locationId - An Integer representing the identifier of the location to retrieve.

Returns:

A CompletableFuture containing a future result of CocLocation

See Also:

getLocations()

getClanRankingsFromLocation

public CompletableFuture<List<CocClanRankInfo>> getClanRankingsFromLocation(int locationId)

Deprecated.

Get clan rankings for a specific location

Parameters:

locationId - An Integer representing the identifier of the location to retrieve.

Returns:

A CompletableFuture containing a future result of a List of CocClanRankInfo

getClanRankingsFromLocation

public CompletableFuture<List<CocClanRankInfo>> getClanRankingsFromLocation(int locationId,
                                                                            int limit)

Deprecated.

Get clan rankings for a specific location

Parameters:

locationId - An Integer representing the identifier of the location to retrieve.

limit - An Integer limiting the number of records returned

Returns:

A CompletableFuture containing a future result for a List of CocClanRankInfo

getClanRankingsFromLocation

public CompletableFuture<List<CocClanRankInfo>> getClanRankingsFromLocation(int locationId,
                                                                            int limit,
                                                                            int before,
                                                                            int after)

Deprecated.

Get clan rankings for a specific location

Parameters:

locationId - An Integer representing the identifier of the location to retrieve.

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 of a List of CocClanRankInfo

getPlayerRankingsFromLocation

public CompletableFuture<List<CocPlayerRankInfo>> getPlayerRankingsFromLocation(int locationId)

Deprecated.

Get player rankings for a specific location

Parameters:

locationId - An Integer representing the identifier of the location to retrieve.

Returns:

A CompletableFuture containing a future result of a List of CocPlayerRankInfo

getPlayerRankingsFromLocation

public CompletableFuture<List<CocPlayerRankInfo>> getPlayerRankingsFromLocation(int locationId,
                                                                                int limit)

Deprecated.

Get player rankings for a specific location

Parameters:

locationId - An Integer representing the identifier of the location to retrieve.

limit - An Integer limiting the number of records returned

Returns:

A CompletableFuture containing a future result of a List of CocPlayerRankInfo

getPlayerRankingsFromLocation

public CompletableFuture<List<CocPlayerRankInfo>> getPlayerRankingsFromLocation(int locationId,
                                                                                int limit,
                                                                                int before,
                                                                                int after)

Deprecated.

Get player rankings for a specific location

Parameters:

locationId - An Integer representing the identifier of the location to retrieve.

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 of a List of CocPlayerRankInfo