net.troja.eve.esi.api

Class LocationApi

java.lang.Object

net.troja.eve.esi.api.LocationApi

public class LocationApi
extends Object

Constructor Summary

Constructors

Constructor and Description
LocationApi()
LocationApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
CharacterLocationResponse	getCharactersCharacterIdLocation(Integer characterId, String datasource, String token, String userAgent, String xUserAgent) Get character location Information about the characters current location.
CharacterShipResponse	getCharactersCharacterIdShip(Integer characterId, String datasource, String token, String userAgent, String xUserAgent) Get current ship Get the current ship type, name and id --- Alternate route: `/v1/characters/{character_id}/ship/` Alternate route: `/legacy/characters/{character_id}/ship/` Alternate route: `/dev/characters/{character_id}/ship/` --- This route is cached for up to 5 seconds SSO Scope: esi-location.read_ship_type.v1
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

LocationApi

public LocationApi()

LocationApi

public LocationApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getCharactersCharacterIdLocation

public CharacterLocationResponse getCharactersCharacterIdLocation(Integer characterId,
                                                                  String datasource,
                                                                  String token,
                                                                  String userAgent,
                                                                  String xUserAgent)
                                                           throws ApiException

Get character location Information about the characters current location. Returns the current solar system id, and also the current station or structure ID if applicable. --- Alternate route: `/v1/characters/{character_id}/location/` Alternate route: `/legacy/characters/{character_id}/location/` Alternate route: `/dev/characters/{character_id}/location/` --- This route is cached for up to 5 seconds SSO Scope: esi-location.read_location.v1

Parameters:

characterId - An EVE character ID (required)

datasource - The server name you would like data from (optional, default to tranquility)

token - Access token to use, if preferred over a header (optional)

userAgent - Client identifier, takes precedence over headers (optional)

xUserAgent - Client identifier, takes precedence over User-Agent (optional)

Returns:

CharacterLocationResponse

Throws:

ApiException - if fails to make API call

getCharactersCharacterIdShip

public CharacterShipResponse getCharactersCharacterIdShip(Integer characterId,
                                                          String datasource,
                                                          String token,
                                                          String userAgent,
                                                          String xUserAgent)
                                                   throws ApiException

Get current ship Get the current ship type, name and id --- Alternate route: `/v1/characters/{character_id}/ship/` Alternate route: `/legacy/characters/{character_id}/ship/` Alternate route: `/dev/characters/{character_id}/ship/` --- This route is cached for up to 5 seconds SSO Scope: esi-location.read_ship_type.v1

Parameters:

characterId - An EVE character ID (required)

datasource - The server name you would like data from (optional, default to tranquility)

token - Access token to use, if preferred over a header (optional)

userAgent - Client identifier, takes precedence over headers (optional)

xUserAgent - Client identifier, takes precedence over User-Agent (optional)

Returns:

CharacterShipResponse

Throws:

ApiException - if fails to make API call