Skip navigation links
A B C D E F G H I L M P R S T U V W _ 

A

access_token - Variable in class help.swgoh.api.SwgohAPIToken
 
allyCode - Variable in class help.swgoh.api.response.RegistrationResponse.GetResponse
 

B

build() - Method in class help.swgoh.api.SwgohAPIBuilder
Validate the SwgohAPISettings object and construct a new SwgohAPIClient instance with it.

C

call(String, String, Map<String, Object>) - Method in enum help.swgoh.api.SwgohAPIClient.API
 
call(String, String, Map<String, Object>, Class<T>) - Method in enum help.swgoh.api.SwgohAPIClient.API
 

D

del - Variable in class help.swgoh.api.response.RegistrationResponse
 
deletedCount - Variable in class help.swgoh.api.response.RegistrationResponse.DeleteResponse
 
DeleteResponse() - Constructor for class help.swgoh.api.response.RegistrationResponse.DeleteResponse
 
discordId - Variable in class help.swgoh.api.response.RegistrationResponse.GetResponse
 

E

expires_in - Variable in class help.swgoh.api.SwgohAPIToken
 

F

fromLocale(Locale) - Static method in enum help.swgoh.api.SwgohAPI.Language
 

G

get - Variable in class help.swgoh.api.response.RegistrationResponse
 
getBattles(Boolean, SwgohAPI.Language, SwgohAPI.BattleField...) - Method in interface help.swgoh.api.SwgohAPI
Returns the current list of all campaigns, nodes and battle data.
getBattles(SwgohAPI.Language, SwgohAPI.BattleField...) - Method in interface help.swgoh.api.SwgohAPI
 
getBattles(Boolean, SwgohAPI.BattleField...) - Method in interface help.swgoh.api.SwgohAPI
 
getBattles(SwgohAPI.BattleField...) - Method in interface help.swgoh.api.SwgohAPI
 
getBattles(Boolean, SwgohAPI.Language, SwgohAPI.BattleField...) - Method in class help.swgoh.api.SwgohAPIClient
 
getDefaultEnums() - Method in class help.swgoh.api.SwgohAPISettings
 
getDefaultLanguage() - Method in class help.swgoh.api.SwgohAPISettings
 
getEvents(Boolean, SwgohAPI.Language, SwgohAPI.EventField...) - Method in interface help.swgoh.api.SwgohAPI
Returns the current event schedule.
getEvents(SwgohAPI.Language, SwgohAPI.EventField...) - Method in interface help.swgoh.api.SwgohAPI
 
getEvents(Boolean, SwgohAPI.EventField...) - Method in interface help.swgoh.api.SwgohAPI
 
getEvents(SwgohAPI.EventField...) - Method in interface help.swgoh.api.SwgohAPI
 
getEvents(Boolean, SwgohAPI.Language, SwgohAPI.EventField...) - Method in class help.swgoh.api.SwgohAPIClient
 
getGuild(int, Boolean, SwgohAPI.Language, SwgohAPI.GuildField...) - Method in interface help.swgoh.api.SwgohAPI
Returns a guild object that contains only basic information for each guild member.
getGuild(int, SwgohAPI.Language, SwgohAPI.GuildField...) - Method in interface help.swgoh.api.SwgohAPI
 
getGuild(int, Boolean, SwgohAPI.GuildField...) - Method in interface help.swgoh.api.SwgohAPI
 
getGuild(int, SwgohAPI.GuildField...) - Method in interface help.swgoh.api.SwgohAPI
 
getGuild(int, Boolean, SwgohAPI.Language, SwgohAPI.GuildField...) - Method in class help.swgoh.api.SwgohAPIClient
 
getGuildUnits(int, boolean, Boolean, SwgohAPI.Language, SwgohAPI.GuildField...) - Method in interface help.swgoh.api.SwgohAPI
Returns a guild object that contains a units report for each guild member.
getGuildUnits(int, boolean, SwgohAPI.Language, SwgohAPI.GuildField...) - Method in interface help.swgoh.api.SwgohAPI
 
getGuildUnits(int, boolean, Boolean, SwgohAPI.GuildField...) - Method in interface help.swgoh.api.SwgohAPI
 
getGuildUnits(int, boolean, SwgohAPI.GuildField...) - Method in interface help.swgoh.api.SwgohAPI
 
getGuildUnits(int, boolean, Boolean, SwgohAPI.Language, SwgohAPI.GuildField...) - Method in class help.swgoh.api.SwgohAPIClient
 
getLargeGuild(int, Boolean, SwgohAPI.Language, SwgohAPI.GuildField...) - Method in interface help.swgoh.api.SwgohAPI
Returns a guild object that contains a full array of player profiles for each guild member.
getLargeGuild(int, SwgohAPI.Language, SwgohAPI.GuildField...) - Method in interface help.swgoh.api.SwgohAPI
 
getLargeGuild(int, Boolean, SwgohAPI.GuildField...) - Method in interface help.swgoh.api.SwgohAPI
 
getLargeGuild(int, SwgohAPI.GuildField...) - Method in interface help.swgoh.api.SwgohAPI
 
getLargeGuild(int, Boolean, SwgohAPI.Language, SwgohAPI.GuildField...) - Method in class help.swgoh.api.SwgohAPIClient
 
getLocale() - Method in enum help.swgoh.api.SwgohAPI.Language
 
getPassword() - Method in class help.swgoh.api.SwgohAPISettings
 
getPlayer(int, Boolean, SwgohAPI.Language, SwgohAPI.PlayerField...) - Method in interface help.swgoh.api.SwgohAPI
 
getPlayer(int, SwgohAPI.Language, SwgohAPI.PlayerField...) - Method in interface help.swgoh.api.SwgohAPI
 
getPlayer(int, Boolean, SwgohAPI.PlayerField...) - Method in interface help.swgoh.api.SwgohAPI
 
getPlayer(int, SwgohAPI.PlayerField...) - Method in interface help.swgoh.api.SwgohAPI
 
getPlayers(List<Integer>, Boolean, SwgohAPI.Language, SwgohAPI.PlayerField...) - Method in interface help.swgoh.api.SwgohAPI
Returns a list of player objects which are identified by the given ally code(s).
getPlayers(List<Integer>, SwgohAPI.Language, SwgohAPI.PlayerField...) - Method in interface help.swgoh.api.SwgohAPI
 
getPlayers(List<Integer>, Boolean, SwgohAPI.PlayerField...) - Method in interface help.swgoh.api.SwgohAPI
 
getPlayers(List<Integer>, SwgohAPI.PlayerField...) - Method in interface help.swgoh.api.SwgohAPI
 
getPlayers(List<Integer>, Boolean, SwgohAPI.Language, SwgohAPI.PlayerField...) - Method in class help.swgoh.api.SwgohAPIClient
 
getRegistrationByAllyCode(List<Integer>) - Method in interface help.swgoh.api.SwgohAPI
This registry is a single-sourced discord-to-ally code registration for all patreon-tier users.
getRegistrationByAllyCode(int) - Method in interface help.swgoh.api.SwgohAPI
 
getRegistrationByAllyCode(List<Integer>) - Method in class help.swgoh.api.SwgohAPIClient
 
getRegistrationByDiscordId(List<String>) - Method in interface help.swgoh.api.SwgohAPI
This registry is a single-sourced discord-to-ally code registration for all patreon-tier users.
getRegistrationByDiscordId(String) - Method in interface help.swgoh.api.SwgohAPI
 
getRegistrationByDiscordId(List<String>) - Method in class help.swgoh.api.SwgohAPIClient
 
GetResponse() - Constructor for class help.swgoh.api.response.RegistrationResponse.GetResponse
 
getSquadRecommendations(SwgohAPI.SquadRecommendationField...) - Method in interface help.swgoh.api.SwgohAPI
Returns the current list of recommended squads, organized around their various uses throughout the game.
getSquadRecommendations(SwgohAPI.SquadRecommendationField...) - Method in class help.swgoh.api.SwgohAPIClient
 
getSupportData(SwgohAPI.Collection, Map<String, Object>, Boolean, SwgohAPI.Language, String...) - Method in interface help.swgoh.api.SwgohAPI
Returns game data listings for organizing your tools and understanding relationships between data.
getSupportData(SwgohAPI.Collection, Boolean, SwgohAPI.Language, String...) - Method in interface help.swgoh.api.SwgohAPI
 
getSupportData(SwgohAPI.Collection, Map<String, Object>, SwgohAPI.Language, String...) - Method in interface help.swgoh.api.SwgohAPI
 
getSupportData(SwgohAPI.Collection, Map<String, Object>, Boolean, String...) - Method in interface help.swgoh.api.SwgohAPI
 
getSupportData(SwgohAPI.Collection, SwgohAPI.Language, String...) - Method in interface help.swgoh.api.SwgohAPI
 
getSupportData(SwgohAPI.Collection, Boolean, String...) - Method in interface help.swgoh.api.SwgohAPI
 
getSupportData(SwgohAPI.Collection, Map<String, Object>, String...) - Method in interface help.swgoh.api.SwgohAPI
 
getSupportData(SwgohAPI.Collection, String...) - Method in interface help.swgoh.api.SwgohAPI
 
getSupportData(SwgohAPI.Collection, Map<String, Object>, Boolean, SwgohAPI.Language, String...) - Method in class help.swgoh.api.SwgohAPIClient
 
getSwgohCode() - Method in enum help.swgoh.api.SwgohAPI.Language
 
getUnits(List<Integer>, boolean, Boolean, SwgohAPI.Language, SwgohAPI.UnitsField...) - Method in interface help.swgoh.api.SwgohAPI
Returns a list of unit details organized by unit instead of by player, similar to the swgoh.gg /units API.
getUnits(List<Integer>, boolean, SwgohAPI.Language, SwgohAPI.UnitsField...) - Method in interface help.swgoh.api.SwgohAPI
 
getUnits(List<Integer>, boolean, Boolean, SwgohAPI.UnitsField...) - Method in interface help.swgoh.api.SwgohAPI
 
getUnits(List<Integer>, boolean, SwgohAPI.UnitsField...) - Method in interface help.swgoh.api.SwgohAPI
 
getUnits(int, boolean, Boolean, SwgohAPI.Language, SwgohAPI.UnitsField...) - Method in interface help.swgoh.api.SwgohAPI
 
getUnits(int, boolean, SwgohAPI.Language, SwgohAPI.UnitsField...) - Method in interface help.swgoh.api.SwgohAPI
 
getUnits(int, boolean, Boolean, SwgohAPI.UnitsField...) - Method in interface help.swgoh.api.SwgohAPI
 
getUnits(int, boolean, SwgohAPI.UnitsField...) - Method in interface help.swgoh.api.SwgohAPI
 
getUnits(List<Integer>, boolean, Boolean, SwgohAPI.Language, SwgohAPI.UnitsField...) - Method in class help.swgoh.api.SwgohAPIClient
 
getUsername() - Method in class help.swgoh.api.SwgohAPISettings
 
getZetaRecommendations(SwgohAPI.ZetaRecommendationField...) - Method in interface help.swgoh.api.SwgohAPI
Returns the current zeta list, rated by their various uses throughout the game.
getZetaRecommendations(SwgohAPI.ZetaRecommendationField...) - Method in class help.swgoh.api.SwgohAPIClient
 

H

help.swgoh.api - package help.swgoh.api
 
help.swgoh.api.exception - package help.swgoh.api.exception
 
help.swgoh.api.response - package help.swgoh.api.response
 

I

index - Variable in class help.swgoh.api.response.RegistrationResponse.PutResponse.UpsertReport
 

L

login(String, String) - Static method in enum help.swgoh.api.SwgohAPIClient.API
 

M

modifiedCount - Variable in class help.swgoh.api.response.RegistrationResponse.PutResponse
 

P

put - Variable in class help.swgoh.api.response.RegistrationResponse
 
PutResponse() - Constructor for class help.swgoh.api.response.RegistrationResponse.PutResponse
 

R

register(Map<Integer, String>) - Method in interface help.swgoh.api.SwgohAPI
This registry is a single-sourced discord-to-ally code registration for all patreon-tier users.
register(int, String) - Method in interface help.swgoh.api.SwgohAPI
 
register(Map<Integer, String>) - Method in class help.swgoh.api.SwgohAPIClient
 
RegistrationResponse - Class in help.swgoh.api.response
 
RegistrationResponse() - Constructor for class help.swgoh.api.response.RegistrationResponse
 
RegistrationResponse.DeleteResponse - Class in help.swgoh.api.response
 
RegistrationResponse.GetResponse - Class in help.swgoh.api.response
 
RegistrationResponse.PutResponse - Class in help.swgoh.api.response
 
RegistrationResponse.PutResponse.UpsertReport - Class in help.swgoh.api.response
 

S

setDefaultEnums(Boolean) - Method in class help.swgoh.api.SwgohAPISettings
 
setDefaultLanguage(SwgohAPI.Language) - Method in class help.swgoh.api.SwgohAPISettings
 
setPassword(String) - Method in class help.swgoh.api.SwgohAPISettings
 
setUsername(String) - Method in class help.swgoh.api.SwgohAPISettings
 
success - Variable in class help.swgoh.api.response.RegistrationResponse.DeleteResponse
 
successCount - Variable in class help.swgoh.api.response.RegistrationResponse.PutResponse
 
SwgohAPI - Interface in help.swgoh.api
Interface that exposes the public methods of SwgohAPIClient.
SwgohAPI.BattleField - Enum in help.swgoh.api
Toggleable fields for the SwgohAPI.getBattles(Boolean, Language, BattleField...) endpoints.
SwgohAPI.Collection - Enum in help.swgoh.api
Complete list of possible data collections that can be queried from the SwgohAPI.getSupportData(Collection, Map, Boolean, Language, String...) endpoints.
SwgohAPI.EventField - Enum in help.swgoh.api
Toggleable fields for the SwgohAPI.getEvents(Boolean, Language, EventField...) endpoints.
SwgohAPI.GuildField - Enum in help.swgoh.api
SwgohAPI.Language - Enum in help.swgoh.api
All game-supported languages that can be used to get localized data from the API responses.
SwgohAPI.PlayerField - Enum in help.swgoh.api
SwgohAPI.SquadRecommendationField - Enum in help.swgoh.api
SwgohAPI.UnitsField - Enum in help.swgoh.api
SwgohAPI.ZetaRecommendationField - Enum in help.swgoh.api
SwgohAPIBuilder - Class in help.swgoh.api
This builder's sole purpose is to compile together the elements of a SwgohAPISettings object, which will be used to create an instance of the SwgohAPI interface.
SwgohAPIBuilder() - Constructor for class help.swgoh.api.SwgohAPIBuilder
 
SwgohAPIClient - Class in help.swgoh.api
 
SwgohAPIClient.API - Enum in help.swgoh.api
 
SwgohAPIException - Exception in help.swgoh.api.exception
Thrown by the API client when an exception occurs.
SwgohAPIException() - Constructor for exception help.swgoh.api.exception.SwgohAPIException
 
SwgohAPIException(String) - Constructor for exception help.swgoh.api.exception.SwgohAPIException
 
SwgohAPIException(Throwable) - Constructor for exception help.swgoh.api.exception.SwgohAPIException
 
SwgohAPIException(String, Throwable) - Constructor for exception help.swgoh.api.exception.SwgohAPIException
 
SwgohAPIRateLimitException - Exception in help.swgoh.api.exception
Thrown by the API client when a web call produces the HTTP status 429.
SwgohAPIRateLimitException(Throwable) - Constructor for exception help.swgoh.api.exception.SwgohAPIRateLimitException
 
SwgohAPISettings - Class in help.swgoh.api
 
SwgohAPISettings() - Constructor for class help.swgoh.api.SwgohAPISettings
 
SwgohAPIToken - Class in help.swgoh.api
 
SwgohAPIToken() - Constructor for class help.swgoh.api.SwgohAPIToken
 

T

token_type - Variable in class help.swgoh.api.SwgohAPIToken
 
total - Variable in class help.swgoh.api.response.RegistrationResponse.PutResponse
 

U

unregister(List<Integer>, List<String>) - Method in interface help.swgoh.api.SwgohAPI
This registry is a single-sourced discord-to-ally code registration for all patreon-tier users.
unregister(List<Integer>, List<String>) - Method in class help.swgoh.api.SwgohAPIClient
 
unregisterAllyCode(int) - Method in interface help.swgoh.api.SwgohAPI
 
unregisterAllyCodes(List<Integer>) - Method in interface help.swgoh.api.SwgohAPI
 
unregisterDiscordId(String) - Method in interface help.swgoh.api.SwgohAPI
 
unregisterDiscordIds(List<String>) - Method in interface help.swgoh.api.SwgohAPI
 
upserted - Variable in class help.swgoh.api.response.RegistrationResponse.PutResponse
 
UpsertReport() - Constructor for class help.swgoh.api.response.RegistrationResponse.PutResponse.UpsertReport
 

V

validate() - Method in class help.swgoh.api.SwgohAPISettings
 
valueOf(String) - Static method in enum help.swgoh.api.SwgohAPI.BattleField
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum help.swgoh.api.SwgohAPI.Collection
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum help.swgoh.api.SwgohAPI.EventField
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum help.swgoh.api.SwgohAPI.GuildField
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum help.swgoh.api.SwgohAPI.Language
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum help.swgoh.api.SwgohAPI.PlayerField
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum help.swgoh.api.SwgohAPI.SquadRecommendationField
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum help.swgoh.api.SwgohAPI.UnitsField
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum help.swgoh.api.SwgohAPI.ZetaRecommendationField
Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum help.swgoh.api.SwgohAPIClient.API
Returns the enum constant of this type with the specified name.
values() - Static method in enum help.swgoh.api.SwgohAPI.BattleField
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum help.swgoh.api.SwgohAPI.Collection
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum help.swgoh.api.SwgohAPI.EventField
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum help.swgoh.api.SwgohAPI.GuildField
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum help.swgoh.api.SwgohAPI.Language
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum help.swgoh.api.SwgohAPI.PlayerField
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum help.swgoh.api.SwgohAPI.SquadRecommendationField
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum help.swgoh.api.SwgohAPI.UnitsField
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum help.swgoh.api.SwgohAPI.ZetaRecommendationField
Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum help.swgoh.api.SwgohAPIClient.API
Returns an array containing the constants of this enum type, in the order they are declared.

W

withDefaultEnums(boolean) - Method in class help.swgoh.api.SwgohAPIBuilder
Defines the default behavior for the enums parameter if none is specified at the time of the request.
withDefaultLanguage(SwgohAPI.Language) - Method in class help.swgoh.api.SwgohAPIBuilder
Defines the default language to use if none is specified at the time of the request.
withPassword(String) - Method in class help.swgoh.api.SwgohAPIBuilder
Defines the password to be sent with the login request.
withUsername(String) - Method in class help.swgoh.api.SwgohAPIBuilder
Defines the username to be sent with the login request.

_

_id - Variable in class help.swgoh.api.response.RegistrationResponse.PutResponse.UpsertReport
 
A B C D E F G H I L M P R S T U V W _ 
Skip navigation links

Copyright © 2018. All rights reserved.