net.troja.eve.esi.api

Class SearchApi

java.lang.Object

net.troja.eve.esi.api.SearchApi

public class SearchApi
extends Object

Constructor Summary

Constructors

Constructor and Description
SearchApi()
SearchApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApiClient	getApiClient()
CharacterSearchResponse	getCharactersCharacterIdSearch(List<String> categories, Integer characterId, String search, String datasource, String language, Boolean strict, String token, String userAgent, String xUserAgent) Search on a string Search for entities that match a given sub-string. --- This route is cached for up to 3600 seconds --- [This route has an available update](https://esi.tech.ccp.is/diff/latest/dev/#GET-/characters /{character_id}/search/) SSO Scope: esi-search.search_structures.v1
SearchResponse	getSearch(List<String> categories, String search, String datasource, String language, Boolean strict, String userAgent, String xUserAgent) Search on a string Search for entities that match a given sub-string. --- This route is cached for up to 3600 seconds --- [This route has an available update](https://esi.tech.ccp.is/diff/latest/dev/#GET-/search/)
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Detail

SearchApi

public SearchApi()

SearchApi

public SearchApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getCharactersCharacterIdSearch

public CharacterSearchResponse getCharactersCharacterIdSearch(List<String> categories,
                                                              Integer characterId,
                                                              String search,
                                                              String datasource,
                                                              String language,
                                                              Boolean strict,
                                                              String token,
                                                              String userAgent,
                                                              String xUserAgent)
                                                       throws ApiException

Search on a string Search for entities that match a given sub-string. --- This route is cached for up to 3600 seconds --- [This route has an available update](https://esi.tech.ccp.is/diff/latest/dev/#GET-/characters /{character_id}/search/) SSO Scope: esi-search.search_structures.v1

Parameters:

categories - Type of entities to search for (required)

characterId - An EVE character ID (required)

search - The string to search on (required)

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

language - Language to use in the response (optional, default to en-us)

strict - Whether the search should be a strict match (optional, default to false)

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

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

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

Returns:

CharacterSearchResponse

Throws:

ApiException - if fails to make API call

getSearch

public SearchResponse getSearch(List<String> categories,
                                String search,
                                String datasource,
                                String language,
                                Boolean strict,
                                String userAgent,
                                String xUserAgent)
                         throws ApiException

Search on a string Search for entities that match a given sub-string. --- This route is cached for up to 3600 seconds --- [This route has an available update](https://esi.tech.ccp.is/diff/latest/dev/#GET-/search/)

Parameters:

categories - Type of entities to search for (required)

search - The string to search on (required)

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

language - Language to use in the response (optional, default to en-us)

strict - Whether the search should be a strict match (optional, default to false)

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

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

Returns:

SearchResponse

Throws:

ApiException - if fails to make API call