gwatlin/io.github.kryszak.gwatlin.api.characters/GWCharactersClient

GWCharactersClient

class GWCharactersClient(apiKey: String)

Client for characters endpoint. Doesn't include the /skills and /specializations sub-endpoints, as these are not available anymore in the schema version that's being used by the internal client. Use buildtabs for that. Documentation can be found in the GW2 Wiki.

Parameters

apiKey

account api key

See also

ApiRequestException

for errors

Constructors

GWCharactersClient

constructor(apiKey: String)

Functions

getActiveBuildTab

fun getActiveBuildTab(characterName: String): BuildTab

Retrieves the currently active BuildTab

getActiveEquipmentTab

fun getActiveEquipmentTab(characterName: String): EquipmentTab

Retrieves the currently active EquipmentTab

fun getBackstory(characterName: String): List<String>?

Retrieves the character's backstory.

fun getBuildTab(characterName: String, tab: Int): BuildTab

Retrieves the specified BuildTab

fun getBuildTabs(characterName: String): List<BuildTab>

Retrieves all buildtabs

fun getCharacter(characterName: String): Character

Retrieves main character info

fun getCharacters(): List<String>

Retrieves the list of characters

fun getCore(characterName: String): CharacterCore

Retrieves core character info

fun getCrafting(characterName: String): List<Crafting>?

Retrieves character crafting info

fun getEquipment(characterName: String): List<EquipmentItem>?

Retrieves the character's equipment

getEquipmentTab

fun getEquipmentTab(characterName: String, tab: Int): EquipmentTab

Retrieves the specified EquipmentTab

getEquipmentTabs

fun getEquipmentTabs(characterName: String): List<EquipmentTab>

Retrieves all EquipmentTabs

fun getHeropoints(characterName: String): List<String>

Retrieves all Heropoints that this character has claimed

fun getInventory(characterName: String): List<Bag?>?

Retrieves the current inventory contents, structured by bag

fun getQuests(characterName: String): List<Int>

Retrieves all quests that this character has done

fun getRecipes(characterName: String): List<Int>?

Retrieves all learned recipes for this character (recipes are shared account wide though)

fun getSAB(characterName: String): CharacterSAB

Retrieves infos about this character's SAB progress and unlocks

fun getTraining(characterName: String): List<Training>?

Retrieves info about this characters' training, like specializations and skills