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 ifNoneMatch, String token) Get character location Information about the characters current location.
CharacterOnlineResponse	getCharactersCharacterIdOnline(Integer characterId, String datasource, String ifNoneMatch, String token) Get character online Checks if the character is currently online --- This route is cached for up to 60 seconds SSO Scope: esi-location.read_online.v1
CharacterShipResponse	getCharactersCharacterIdShip(Integer characterId, String datasource, String ifNoneMatch, String token) Get current ship Get the current ship type, name and id --- 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 ifNoneMatch,
                                                                  String token)
                                                           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 --- 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)

ifNoneMatch - ETag from a previous request. A 304 will be returned if this matches the current ETag (optional)

token - Access token to use if unable to set a header (optional)

Returns:

CharacterLocationResponse

Throws:

ApiException - if fails to make API call

getCharactersCharacterIdOnline

public CharacterOnlineResponse getCharactersCharacterIdOnline(Integer characterId,
                                                              String datasource,
                                                              String ifNoneMatch,
                                                              String token)
                                                       throws ApiException

Get character online Checks if the character is currently online --- This route is cached for up to 60 seconds SSO Scope: esi-location.read_online.v1

Parameters:

characterId - An EVE character ID (required)

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

ifNoneMatch - ETag from a previous request. A 304 will be returned if this matches the current ETag (optional)

token - Access token to use if unable to set a header (optional)

Returns:

CharacterOnlineResponse

Throws:

ApiException - if fails to make API call

getCharactersCharacterIdShip

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

Get current ship Get the current ship type, name and id --- 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)

ifNoneMatch - ETag from a previous request. A 304 will be returned if this matches the current ETag (optional)

token - Access token to use if unable to set a header (optional)

Returns:

CharacterShipResponse

Throws:

ApiException - if fails to make API call