help.swgoh.api

Class SwgohAPIClient

java.lang.Object

help.swgoh.api.SwgohAPIClient

All Implemented Interfaces:

SwgohAPI

public class SwgohAPIClient
extends Object
implements SwgohAPI

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SwgohAPIClient.API

Nested classes/interfaces inherited from interface help.swgoh.api.SwgohAPI

SwgohAPI.BattleField, SwgohAPI.Collection, SwgohAPI.EventField, SwgohAPI.GuildField, SwgohAPI.Language, SwgohAPI.PlayerField, SwgohAPI.SquadRecommendationField, SwgohAPI.UnitsField, SwgohAPI.ZetaRecommendationField

Method Summary

Modifier and Type	Method and Description
CompletableFuture<String>	getBattles(Boolean enums, SwgohAPI.Language language, SwgohAPI.BattleField... fields) Returns the current list of all campaigns, nodes and battle data.
CompletableFuture<String>	getEvents(Boolean enums, SwgohAPI.Language language, SwgohAPI.EventField... fields) Returns the current event schedule.
CompletableFuture<String>	getGuild(int allyCode, Boolean enums, SwgohAPI.Language language, SwgohAPI.GuildField... fields) Returns a guild object that contains only basic information for each guild member.
CompletableFuture<String>	getGuildUnits(int allyCode, boolean includeMods, Boolean enums, SwgohAPI.Language language, SwgohAPI.GuildField... fields) Returns a guild object that contains a units report for each guild member.
CompletableFuture<String>	getLargeGuild(int allyCode, Boolean enums, SwgohAPI.Language language, SwgohAPI.GuildField... fields) Returns a guild object that contains a full array of player profiles for each guild member.
CompletableFuture<String>	getPlayers(List<Integer> allyCodes, Boolean enums, SwgohAPI.Language language, SwgohAPI.PlayerField... fields) Returns a list of player objects which are identified by the given ally code(s).
CompletableFuture<RegistrationResponse>	getRegistrationByAllyCode(List<Integer> allyCodes) This registry is a single-sourced discord-to-ally code registration for all patreon-tier users.
CompletableFuture<RegistrationResponse>	getRegistrationByDiscordId(List<String> discordIds) This registry is a single-sourced discord-to-ally code registration for all patreon-tier users.
CompletableFuture<String>	getSquadRecommendations(SwgohAPI.SquadRecommendationField... fields) Returns the current list of recommended squads, organized around their various uses throughout the game.
CompletableFuture<String>	getSupportData(SwgohAPI.Collection collection, Map<String,Object> matchCriteria, Boolean enums, SwgohAPI.Language language, String... fields) Returns game data listings for organizing your tools and understanding relationships between data.
CompletableFuture<String>	getUnits(List<Integer> allyCodes, boolean includeMods, Boolean enums, SwgohAPI.Language language, SwgohAPI.UnitsField... fields) Returns a list of unit details organized by unit instead of by player, similar to the swgoh.gg /units API.
CompletableFuture<String>	getZetaRecommendations(SwgohAPI.ZetaRecommendationField... fields) Returns the current zeta list, rated by their various uses throughout the game.
CompletableFuture<RegistrationResponse>	register(Map<Integer,String> allyCodeDiscordIdMappings) This registry is a single-sourced discord-to-ally code registration for all patreon-tier users.
CompletableFuture<RegistrationResponse>	unregister(List<Integer> allyCodes, List<String> discordIds) This registry is a single-sourced discord-to-ally code registration for all patreon-tier users.

Methods inherited from class java.lang.Object

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

Methods inherited from interface help.swgoh.api.SwgohAPI

getBattles, getBattles, getBattles, getEvents, getEvents, getEvents, getGuild, getGuild, getGuild, getGuildUnits, getGuildUnits, getGuildUnits, getLargeGuild, getLargeGuild, getLargeGuild, getPlayer, getPlayer, getPlayer, getPlayer, getPlayers, getPlayers, getPlayers, getRegistrationByAllyCode, getRegistrationByDiscordId, getSupportData, getSupportData, getSupportData, getSupportData, getSupportData, getSupportData, getSupportData, getUnits, getUnits, getUnits, getUnits, getUnits, getUnits, getUnits, register, unregisterAllyCode, unregisterAllyCodes, unregisterDiscordId, unregisterDiscordIds

Method Detail

getPlayers

public CompletableFuture<String> getPlayers(List<Integer> allyCodes,
                                            Boolean enums,
                                            SwgohAPI.Language language,
                                            SwgohAPI.PlayerField... fields)

Description copied from interface: SwgohAPI

Returns a list of player objects which are identified by the given ally code(s). Cache sync: Registered user: 4 hours Verified user: 2 hours Patreon user: 1 hour https://api.swgoh.help/swgoh

Specified by:

getPlayers in interface SwgohAPI

Parameters:

allyCodes - Ally code(s) of the players to request.

enums - Optionally return enumerated items as their string equivalents.

language - Optional language to return translated names. If no language specified, no translations will be applied.

fields - Optional projection of SwgohAPI.PlayerFields you want returned. If no fields are specified, all fields will be returned.

Returns:

player data by individual or group of ally codes.

getGuild

public CompletableFuture<String> getGuild(int allyCode,
                                          Boolean enums,
                                          SwgohAPI.Language language,
                                          SwgohAPI.GuildField... fields)

Description copied from interface: SwgohAPI

Returns a guild object that contains only basic information for each guild member. For a full array of player profiles in the response, see SwgohAPI.getLargeGuild(int, Boolean, Language, GuildField...) For a guild-wide units report instead of an array of player profiles, see SwgohAPI.getGuildUnits(int, boolean, Boolean, Language, GuildField...) Cache sync: Registered user: 6 hours Verified user: 4 hours Patreon user: 3 hours https://api.swgoh.help/swgoh

Specified by:

getGuild in interface SwgohAPI

Parameters:

allyCode - Ally code of any guild member in guild to request.

enums - Optionally return enumerated items as their string equivalents.

language - Optional language to return translated names. If no language specified, no translations will be applied.

fields - Optional projection of SwgohAPI.GuildFields you want returned. If no fields are specified, all fields will be returned.

Returns:

guild data by individual ally code of guild member.

getLargeGuild

public CompletableFuture<String> getLargeGuild(int allyCode,
                                               Boolean enums,
                                               SwgohAPI.Language language,
                                               SwgohAPI.GuildField... fields)

Description copied from interface: SwgohAPI

Returns a guild object that contains a full array of player profiles for each guild member. Note: Large reply object. For a basic view of the player roster, see SwgohAPI.getGuild(int, Boolean, Language, GuildField...) For a guild-wide units report instead of an array of player profiles, see SwgohAPI.getGuildUnits(int, boolean, Boolean, Language, GuildField...) Cache sync: Registered user: 6 hours Verified user: 4 hours Patreon user: 3 hours https://api.swgoh.help/swgoh

Specified by:

getLargeGuild in interface SwgohAPI

Parameters:

allyCode - Ally code of any guild member in guild to request.

enums - Optionally return enumerated items as their string equivalents.

language - Optional language to return translated names. If no language specified, no translations will be applied.

fields - Optional projection of SwgohAPI.GuildFields you want returned. If no fields are specified, all fields will be returned.

Returns:

guild data by individual ally code of guild member.

getGuildUnits

public CompletableFuture<String> getGuildUnits(int allyCode,
                                               boolean includeMods,
                                               Boolean enums,
                                               SwgohAPI.Language language,
                                               SwgohAPI.GuildField... fields)

Description copied from interface: SwgohAPI

Returns a guild object that contains a units report for each guild member. Note: Large reply object. For a basic view of the player roster, see SwgohAPI.getGuild(int, Boolean, Language, GuildField...) For a full array of player profiles in the response, see SwgohAPI.getLargeGuild(int, Boolean, Language, GuildField...) Cache sync: Registered user: 6 hours Verified user: 4 hours Patreon user: 3 hours https://api.swgoh.help/swgoh

Specified by:

getGuildUnits in interface SwgohAPI

Parameters:

allyCode - Ally code of any guild member in guild to request.

includeMods - Optionally include unit mods in units report. Note: Large reply object

enums - Optionally return enumerated items as their string equivalents.

language - Optional language to return translated names. If no language specified, no translations will be applied.

fields - Optional projection of SwgohAPI.GuildFields you want returned. If no fields are specified, all fields will be returned.

Returns:

guild data by individual ally code of guild member.

getUnits

public CompletableFuture<String> getUnits(List<Integer> allyCodes,
                                          boolean includeMods,
                                          Boolean enums,
                                          SwgohAPI.Language language,
                                          SwgohAPI.UnitsField... fields)

Description copied from interface: SwgohAPI

Returns a list of unit details organized by unit instead of by player, similar to the swgoh.gg /units API. Cache sync: Registered user: 4 hours Verified user: 2 hours Patreon user: 1 hour https://api.swgoh.help/swgoh

Specified by:

getUnits in interface SwgohAPI

Parameters:

allyCodes - Ally code(s) of the players to request.

includeMods - Optionally include unit-mods in report. Note: Large reply object

enums - Optionally return enumerated items as their string equivalents.

language - (in conjunction with mods) Optionally converts mod stat values to text.

fields - Optional projection of SwgohAPI.UnitsFields you want returned. If no fields are specified, all fields will be returned.

Returns:

player profiles organized by units for individual or group of ally codes.

getZetaRecommendations

public CompletableFuture<String> getZetaRecommendations(SwgohAPI.ZetaRecommendationField... fields)

Description copied from interface: SwgohAPI

Returns the current zeta list, rated by their various uses throughout the game. This dataset is an aggregated summary of rankings collected through a grouping of krakens, whales, dolphins and free-to-players. Note: This dataset is in the care of a third party and does not have available translations. Cache sync: 7 days https://api.swgoh.help/swgoh

Specified by:

getZetaRecommendations in interface SwgohAPI

Parameters:

fields - Optional projection of SwgohAPI.ZetaRecommendationFields you want returned. If no fields are specified, all fields will be returned.

Returns:

current zeta list, rated by their various uses throughout the game.

getSquadRecommendations

public CompletableFuture<String> getSquadRecommendations(SwgohAPI.SquadRecommendationField... fields)

Description copied from interface: SwgohAPI

Returns the current list of recommended squads, organized around their various uses throughout the game. This dataset is provided by swgoh.help home-site and additions or changes can be requested in their Discord server. https://discord.gg/kau4XTB Note: This dataset is in the care of a third party and does not have available translations. Cache sync: 7 days https://api.swgoh.help/swgoh

Specified by:

getSquadRecommendations in interface SwgohAPI

Parameters:

fields - Optional projection of SwgohAPI.SquadRecommendationFields you want returned. If no fields are specified, all fields will be returned.

Returns:

current list of recommended squads, organized around their various uses throughout the game.

getEvents

public CompletableFuture<String> getEvents(Boolean enums,
                                           SwgohAPI.Language language,
                                           SwgohAPI.EventField... fields)

Description copied from interface: SwgohAPI

Returns the current event schedule. Cache sync: 4 hours https://api.swgoh.help/swgoh

Specified by:

getEvents in interface SwgohAPI

Parameters:

enums - Optionally return enumerated items as their string equivalents.

language - Optional language to return translated names. If no language specified, no translations will be applied.

fields - Optional projection of SwgohAPI.EventFields you want returned. If no fields are specified, all fields will be returned.

Returns:

current event schedule.

getBattles

public CompletableFuture<String> getBattles(Boolean enums,
                                            SwgohAPI.Language language,
                                            SwgohAPI.BattleField... fields)

Description copied from interface: SwgohAPI

Returns the current list of all campaigns, nodes and battle data. Cache sync: 4 hours https://api.swgoh.help/swgoh

Specified by:

getBattles in interface SwgohAPI

Parameters:

enums - Optionally return enumerated items as their string equivalents.

language - Optional language to return translated names. If no language specified, no translations will be applied.

fields - Optional projection of SwgohAPI.BattleFields you want returned. If no fields are specified, all fields will be returned.

Returns:

current list of all campaigns, nodes and battle data.

getSupportData

public CompletableFuture<String> getSupportData(SwgohAPI.Collection collection,
                                                Map<String,Object> matchCriteria,
                                                Boolean enums,
                                                SwgohAPI.Language language,
                                                String... fields)

Description copied from interface: SwgohAPI

Returns game data listings for organizing your tools and understanding relationships between data. The match criteria should be the $match's body, according to mongodb specifications. https://docs.mongodb.com/manual/reference/operator/aggregation/match/ Cache sync: on game updates https://api.swgoh.help/swgoh

Specified by:

getSupportData in interface SwgohAPI

Parameters:

collection - Name of the collection to access.

matchCriteria - Optionally include match criteria to filter down response.

enums - Optionally return enumerated items as their string equivalents.

language - Optional language to return translated names. If no language specified, no translations will be applied.

fields - Optional projection of fields you want returned. If no fields are specified, all fields will be returned.

Returns:

game data listings for organizing your tools and understanding relationships between data.

register

public CompletableFuture<RegistrationResponse> register(Map<Integer,String> allyCodeDiscordIdMappings)

Description copied from interface: SwgohAPI

This registry is a single-sourced discord-to-ally code registration for all patreon-tier users. Add or update registrations from the pool for all patreon-tiered tools to access. https://api.swgoh.help/patreon

Specified by:

register in interface SwgohAPI

Parameters:

allyCodeDiscordIdMappings - Map of ally code/discord ID associations

Returns:

details about the success of the registration

unregister

public CompletableFuture<RegistrationResponse> unregister(List<Integer> allyCodes,
                                                          List<String> discordIds)

Description copied from interface: SwgohAPI

This registry is a single-sourced discord-to-ally code registration for all patreon-tier users. Delete registrations from the pool that all patreon-tiered tools can access. Each ally code that is passed in will have its single associated Discord ID removed. Each Discord ID that is passed in will have all of its associated ally codes removed. https://api.swgoh.help/patreon

Specified by:

unregister in interface SwgohAPI

Parameters:

allyCodes - List of ally codes to unregister

discordIds - List of Discord IDs to unregister

Returns:

details about the success of the unregistration

getRegistrationByAllyCode

public CompletableFuture<RegistrationResponse> getRegistrationByAllyCode(List<Integer> allyCodes)

Description copied from interface: SwgohAPI

This registry is a single-sourced discord-to-ally code registration for all patreon-tier users. Fetch registrations to the pool for for the specified ally code(s). https://api.swgoh.help/patreon

Specified by:

getRegistrationByAllyCode in interface SwgohAPI

Parameters:

allyCodes - List of ally codes to search

Returns:

registered pairing of ally code / discord ID, if any.

getRegistrationByDiscordId

public CompletableFuture<RegistrationResponse> getRegistrationByDiscordId(List<String> discordIds)

Description copied from interface: SwgohAPI

This registry is a single-sourced discord-to-ally code registration for all patreon-tier users. Fetch registrations to the pool for for the specified discord ID(s). The discord "snowflake" ID format is specified here: https://discordapp.com/developers/docs/reference#snowflakes https://api.swgoh.help/patreon

Specified by:

getRegistrationByDiscordId in interface SwgohAPI

Parameters:

discordIds - List of discord IDs to search

Returns:

registered pairing of ally code / discord ID, if any.