net.troja.eve.esi.api

Class ContactsApi

java.lang.Object

net.troja.eve.esi.api.ContactsApi

public class ContactsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
ContactsApi()
ContactsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
void	deleteCharactersCharacterIdContacts(Integer characterId, List<Integer> contactIds, String datasource, String token, String userAgent, String xUserAgent) Delete contacts Bulk delete contacts --- SSO Scope: esi-characters.write_contacts.v1
List<AllianceContactsResponse>	getAlliancesAllianceIdContacts(Integer allianceId, String datasource, Integer page, String token, String userAgent, String xUserAgent) Get alliance contacts Return contacts of an alliance --- This route is cached for up to 300 seconds SSO Scope: esi-alliances.read_contacts.v1
ApiClient	getApiClient()
List<ContactsResponse>	getCharactersCharacterIdContacts(Integer characterId, String datasource, Integer page, String token, String userAgent, String xUserAgent) Get contacts Return contacts of a character --- This route is cached for up to 300 seconds SSO Scope: esi-characters.read_contacts.v1
List<ContactLabelsResponse>	getCharactersCharacterIdContactsLabels(Integer characterId, String datasource, String token, String userAgent, String xUserAgent) Get contact labels Return custom labels for contacts the character defined --- This route is cached for up to 300 seconds SSO Scope: esi-characters.read_contacts.v1
List<CorporationContactsResponse>	getCorporationsCorporationIdContacts(Integer corporationId, String datasource, Integer page, String token, String userAgent, String xUserAgent) Get corporation contacts Return contacts of a corporation --- This route is cached for up to 300 seconds SSO Scope: esi-corporations.read_contacts.v1
List<Integer>	postCharactersCharacterIdContacts(Integer characterId, List<Integer> contactIds, Float standing, String datasource, Long labelId, String token, String userAgent, Boolean watched, String xUserAgent) Add contacts Bulk add contacts with same settings --- SSO Scope: esi-characters.write_contacts.v1
void	putCharactersCharacterIdContacts(Integer characterId, List<Integer> contactIds, Float standing, String datasource, Long labelId, String token, String userAgent, Boolean watched, String xUserAgent) Edit contacts Bulk edit contacts with same settings --- SSO Scope: esi-characters.write_contacts.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

ContactsApi

public ContactsApi()

ContactsApi

public ContactsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

deleteCharactersCharacterIdContacts

public void deleteCharactersCharacterIdContacts(Integer characterId,
                                                List<Integer> contactIds,
                                                String datasource,
                                                String token,
                                                String userAgent,
                                                String xUserAgent)
                                         throws ApiException

Delete contacts Bulk delete contacts --- SSO Scope: esi-characters.write_contacts.v1

Parameters:

characterId - An EVE character ID (required)

contactIds - A list of contacts to delete (required)

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

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)

Throws:

ApiException - if fails to make API call

getAlliancesAllianceIdContacts

public List<AllianceContactsResponse> getAlliancesAllianceIdContacts(Integer allianceId,
                                                                     String datasource,
                                                                     Integer page,
                                                                     String token,
                                                                     String userAgent,
                                                                     String xUserAgent)
                                                              throws ApiException

Get alliance contacts Return contacts of an alliance --- This route is cached for up to 300 seconds SSO Scope: esi-alliances.read_contacts.v1

Parameters:

allianceId - An EVE alliance ID (required)

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

page - Which page of results to return (optional, default to 1)

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:

List<AllianceContactsResponse>

Throws:

ApiException - if fails to make API call

getCharactersCharacterIdContacts

public List<ContactsResponse> getCharactersCharacterIdContacts(Integer characterId,
                                                               String datasource,
                                                               Integer page,
                                                               String token,
                                                               String userAgent,
                                                               String xUserAgent)
                                                        throws ApiException

Get contacts Return contacts of a character --- This route is cached for up to 300 seconds SSO Scope: esi-characters.read_contacts.v1

Parameters:

characterId - An EVE character ID (required)

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

page - Which page of results to return (optional, default to 1)

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:

List<ContactsResponse>

Throws:

ApiException - if fails to make API call

getCharactersCharacterIdContactsLabels

public List<ContactLabelsResponse> getCharactersCharacterIdContactsLabels(Integer characterId,
                                                                          String datasource,
                                                                          String token,
                                                                          String userAgent,
                                                                          String xUserAgent)
                                                                   throws ApiException

Get contact labels Return custom labels for contacts the character defined --- This route is cached for up to 300 seconds SSO Scope: esi-characters.read_contacts.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 unable to set a header (optional)

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

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

Returns:

List<ContactLabelsResponse>

Throws:

ApiException - if fails to make API call

getCorporationsCorporationIdContacts

public List<CorporationContactsResponse> getCorporationsCorporationIdContacts(Integer corporationId,
                                                                              String datasource,
                                                                              Integer page,
                                                                              String token,
                                                                              String userAgent,
                                                                              String xUserAgent)
                                                                       throws ApiException

Get corporation contacts Return contacts of a corporation --- This route is cached for up to 300 seconds SSO Scope: esi-corporations.read_contacts.v1

Parameters:

corporationId - An EVE corporation ID (required)

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

page - Which page of results to return (optional, default to 1)

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:

List<CorporationContactsResponse>

Throws:

ApiException - if fails to make API call

postCharactersCharacterIdContacts

public List<Integer> postCharactersCharacterIdContacts(Integer characterId,
                                                       List<Integer> contactIds,
                                                       Float standing,
                                                       String datasource,
                                                       Long labelId,
                                                       String token,
                                                       String userAgent,
                                                       Boolean watched,
                                                       String xUserAgent)
                                                throws ApiException

Add contacts Bulk add contacts with same settings --- SSO Scope: esi-characters.write_contacts.v1

Parameters:

characterId - An EVE character ID (required)

contactIds - A list of contacts to add (required)

standing - Standing for the new contact (required)

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

labelId - Add a custom label to the new contact (optional, default to 0)

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

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

watched - Whether the new contact should be watched, note this is only effective on characters (optional, default to false)

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

Returns:

List<Integer>

Throws:

ApiException - if fails to make API call

putCharactersCharacterIdContacts

public void putCharactersCharacterIdContacts(Integer characterId,
                                             List<Integer> contactIds,
                                             Float standing,
                                             String datasource,
                                             Long labelId,
                                             String token,
                                             String userAgent,
                                             Boolean watched,
                                             String xUserAgent)
                                      throws ApiException

Edit contacts Bulk edit contacts with same settings --- SSO Scope: esi-characters.write_contacts.v1

Parameters:

characterId - An EVE character ID (required)

contactIds - A list of contacts to edit (required)

standing - Standing for the contact (required)

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

labelId - Add a custom label to the contact, use 0 for clearing label (optional, default to 0)

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

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

watched - Whether the contact should be watched, note this is only effective on characters (optional, default to false)

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

Throws:

ApiException - if fails to make API call