Class RoutesApi


  • public class RoutesApi
    extends Object
    • Constructor Detail

      • RoutesApi

        public RoutesApi()
      • RoutesApi

        public RoutesApi​(ApiClient apiClient)
    • Method Detail

      • getApiClient

        public ApiClient getApiClient()
      • setApiClient

        public void setApiClient​(ApiClient apiClient)
      • getRouteOriginDestinationCall

        public okhttp3.Call getRouteOriginDestinationCall​(Integer destination,
                                                          Integer origin,
                                                          List<Integer> avoid,
                                                          List<List<Integer>> connections,
                                                          String datasource,
                                                          String flag,
                                                          String ifNoneMatch,
                                                          ApiCallback _callback)
                                                   throws ApiException
        Build call for getRouteOriginDestination
        Parameters:
        destination - destination solar system ID (required)
        origin - origin solar system ID (required)
        avoid - avoid solar system ID(s) (optional)
        connections - connected solar system pairs (optional)
        datasource - The server name you would like data from (optional, default to tranquility)
        flag - route security preference (optional, default to shortest)
        ifNoneMatch - ETag from a previous request. A 304 will be returned if this matches the current ETag (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
      • getRouteOriginDestination

        public List<Integer> getRouteOriginDestination​(Integer destination,
                                                       Integer origin,
                                                       List<Integer> avoid,
                                                       List<List<Integer>> connections,
                                                       String datasource,
                                                       String flag,
                                                       String ifNoneMatch)
                                                throws ApiException
        Get route Get the systems between origin and destination --- This route is cached for up to 86400 seconds
        Parameters:
        destination - destination solar system ID (required)
        origin - origin solar system ID (required)
        avoid - avoid solar system ID(s) (optional)
        connections - connected solar system pairs (optional)
        datasource - The server name you would like data from (optional, default to tranquility)
        flag - route security preference (optional, default to shortest)
        ifNoneMatch - ETag from a previous request. A 304 will be returned if this matches the current ETag (optional)
        Returns:
        List<Integer>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • getRouteOriginDestinationWithHttpInfo

        public ApiResponse<List<Integer>> getRouteOriginDestinationWithHttpInfo​(Integer destination,
                                                                                Integer origin,
                                                                                List<Integer> avoid,
                                                                                List<List<Integer>> connections,
                                                                                String datasource,
                                                                                String flag,
                                                                                String ifNoneMatch)
                                                                         throws ApiException
        Get route Get the systems between origin and destination --- This route is cached for up to 86400 seconds
        Parameters:
        destination - destination solar system ID (required)
        origin - origin solar system ID (required)
        avoid - avoid solar system ID(s) (optional)
        connections - connected solar system pairs (optional)
        datasource - The server name you would like data from (optional, default to tranquility)
        flag - route security preference (optional, default to shortest)
        ifNoneMatch - ETag from a previous request. A 304 will be returned if this matches the current ETag (optional)
        Returns:
        ApiResponse<List<Integer>>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
      • getRouteOriginDestinationAsync

        public okhttp3.Call getRouteOriginDestinationAsync​(Integer destination,
                                                           Integer origin,
                                                           List<Integer> avoid,
                                                           List<List<Integer>> connections,
                                                           String datasource,
                                                           String flag,
                                                           String ifNoneMatch,
                                                           ApiCallback<List<Integer>> _callback)
                                                    throws ApiException
        Get route (asynchronously) Get the systems between origin and destination --- This route is cached for up to 86400 seconds
        Parameters:
        destination - destination solar system ID (required)
        origin - origin solar system ID (required)
        avoid - avoid solar system ID(s) (optional)
        connections - connected solar system pairs (optional)
        datasource - The server name you would like data from (optional, default to tranquility)
        flag - route security preference (optional, default to shortest)
        ifNoneMatch - ETag from a previous request. A 304 will be returned if this matches the current ETag (optional)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object