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

Class CocClans

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

Deprecated.

@Deprecated
 @ApiStatus.ScheduledForRemoval
public class CocClans
extends CocWebApiInterface

A Web API Implementation of the Clan interface. Contains methods for clan-related inquiries.

Author:

Rafael Luis Ibasco

See Also:

Clash of Clans API - Clans

Field Summary

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

VERSION_1, VERSION_2, VERSION_3

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
CompletableFuture<CocClanDetailedInfo>	getClanInfo(String clanTag) Deprecated. Get information about a single clan by clan tag.
CompletableFuture<List<CocPlayerBasicInfo>>	getClanMembers(String clanTag) Deprecated. List clan members
CompletableFuture<List<CocPlayerBasicInfo>>	getClanMembers(String clanTag, int limit) Deprecated. List clan members
CompletableFuture<List<CocPlayerBasicInfo>>	getClanMembers(String clanTag, int limit, int after, int before) Deprecated. List clan members
CompletableFuture<List<CocWarLogEntry>>	getClanWarLog(String clanTag) Deprecated. Retrieve clan's clan war log
CompletableFuture<List<CocWarLogEntry>>	getClanWarLog(String clanTag, int limit, int after, int before) Deprecated. Retrieve clan's clan war log
CompletableFuture<List<CocClanDetailedInfo>>	searchClans(CocSearchCriteria criteria) Deprecated. Search all clans by name and/or filtering the results using various criteria.

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

CocClans

public CocClans(CocWebApiClient client)

Deprecated.

Default Constructor

Parameters:

client - A CocWebApiClient instance

Method Detail

searchClans

public CompletableFuture<List<CocClanDetailedInfo>> searchClans(CocSearchCriteria criteria)

Deprecated.

Search all clans by name and/or filtering the results using various criteria. At least one filtering criteria must be defined and if name is used as part of search, it is required to be at least three characters long. It is not possible to specify ordering for results so clients should not rely on any specific ordering as that may change in the future releases of the API.

Parameters:

criteria - A CocSearchCriteria to help your life much easier

Returns:

A CompletableFuture containing a List of clans matching the criteria. Empty if no match found.

getClanInfo

public CompletableFuture<CocClanDetailedInfo> getClanInfo(String clanTag)

Deprecated.

Get information about a single clan by clan tag. Clan tags can be found using clan search operation. Note that clan tags start with hash character '#' and that needs to be URL-encoded properly to work in URL, so for example clan tag '#2ABC' would become '%232ABC' in the URL.

Parameters:

clanTag - A String preceded by a hash tag '#' character

Returns:

A CompletableFuture returning an instance of CocClanDetailedInfo

getClanMembers

public CompletableFuture<List<CocPlayerBasicInfo>> getClanMembers(String clanTag)

Deprecated.

List clan members

Parameters:

clanTag - A String representing the clan tag

Returns:

A CompletableFuture returning an instance of List of type CocPlayerBasicInfo

getClanMembers

public CompletableFuture<List<CocPlayerBasicInfo>> getClanMembers(String clanTag,
                                                                  int limit,
                                                                  int after,
                                                                  int before)

Deprecated.

List clan members

Parameters:

clanTag - A String representing the clan tag

limit - An Integer limiting the number of records returned

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.

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.

Returns:

A CompletableFuture returning an instance of List of type CocPlayerBasicInfo

getClanMembers

public CompletableFuture<List<CocPlayerBasicInfo>> getClanMembers(String clanTag,
                                                                  int limit)

Deprecated.

List clan members

Parameters:

clanTag - A String representing the clan tag

limit - An Integer limiting the number of records returned

Returns:

A CompletableFuture returning an instance of List of type CocPlayerBasicInfo

getClanWarLog

public CompletableFuture<List<CocWarLogEntry>> getClanWarLog(String clanTag)

Deprecated.

Retrieve clan's clan war log

Parameters:

clanTag - A String preceded by a hash tag '#' character

Returns:

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

getClanWarLog

public CompletableFuture<List<CocWarLogEntry>> getClanWarLog(String clanTag,
                                                             int limit,
                                                             int after,
                                                             int before)

Deprecated.

Retrieve clan's clan war log

Parameters:

clanTag - A String preceded by a hash tag '#' character

limit - An Integer limiting the number of records returned

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.

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.

Returns:

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