com.wirefreethought.geodb.client.net.ApiCallback Maven / Gradle / Ivy

Go to download
/*
 * GeoDB API
 * The GeoDB API focuses on getting global city and region data. Easily obtain country, region, and city data for use in your apps! Filter cities by name prefix, country, location, time-zone, and even minimum population.
Sort cities by name, country code, elevation, and population - or any combination of these.
 Get all country regions.
 Get all cities in a given region.
Display results in multiple languages (currently, English, French, German, Russian, and Spanish).
 RESTful API adheres to industry best-practices, including HATEOAS-style links to facilitate paging results.
 Backed by cloud-based load-balanced infrastructure for resiliency and performance!
 Data is periodically refreshed from GeoNames and WikiData.
Notes:
All endpoints implicitly support JSONP-style invocation via an optional callback param.
Since the database is periodically updated, this may very rarely result in certain cities being marked deleted (e.g., duplicates removed). By default, endpoints returning city data will exclude cities marked deleted. However, in the unlikely event that this occurs while your app is paging through a set of affected results - and you care about the paged results suddenly changing underneath - specify includeDeleted=SINCE_YESTERDAY (or SINCE_LAST_WEEK if you're really paranoid!).
Useful Resources
SDKsAngular, Sample App
Java
JavaScript
Swagger Docs
Usage License
 *
 * OpenAPI spec version: 1.0.0
 * 
 *
 * NOTE: This class is auto generated by the swagger code generator program.
 * https://github.com/swagger-api/swagger-codegen.git
 * Do not edit the class manually.
 */


package com.wirefreethought.geodb.client.net;

import java.io.IOException;

import java.util.Map;
import java.util.List;

/**
 * Callback for asynchronous API call.
 *
 * @param  The return type
 */
public interface ApiCallback {
    /**
     * This is called when the API call fails.
     *
     * @param e The exception causing the failure
     * @param statusCode Status code of the response if available, otherwise it would be 0
     * @param responseHeaders Headers of the response if available, otherwise it would be null
     */
    void onFailure(ApiException e, int statusCode, Map> responseHeaders);

    /**
     * This is called when the API call succeeded.
     *
     * @param result The result deserialized from response
     * @param statusCode Status code of the response
     * @param responseHeaders Headers of the response
     */
    void onSuccess(T result, int statusCode, Map> responseHeaders);

    /**
     * This is called when the API upload processing.
     *
     * @param bytesWritten bytes Written
     * @param contentLength content length of request body
     * @param done write end
     */
    void onUploadProgress(long bytesWritten, long contentLength, boolean done);

    /**
     * This is called when the API downlond processing.
     *
     * @param bytesRead bytes Read
     * @param contentLength content lenngth of the response
     * @param done Read end
     */
    void onDownloadProgress(long bytesRead, long contentLength, boolean done);
}