Package ai.nextbillion.maps

Interface PendingResult<T>

Type Parameters:
T - the type of the result object.
All Known Implementing Classes:
DirectionsApiRequest, DistanceMatrixApiRequest, FindPlaceFromTextRequest, GaePendingResult, GeocodingApiRequest, GeolocationApiRequest, NearbySearchRequest, OkHttpPendingResult, PhotoRequest, PlaceAutocompleteRequest, QueryAutocompleteRequest, TextSearchRequest
public interface PendingResult<T>
A pending result from an API call.

  • Nested Class Summary

    Nested Classes 
    Modifier and Type Interface Description
    static interface  PendingResult.Callback<T>
    The callback interface the API client code needs to implement to handle API results.

  • Method Summary

    Modifier and Type Method Description
    T await()
    Performs the request synchronously.
    T awaitIgnoreError()
    Performs the request synchronously, ignoring exceptions while performing the request and errors returned by the server.
    void cancel()
    Attempts to cancel the request.
    void setCallback​(PendingResult.Callback<T> callback)
    Performs the request asynchronously, calling onResult or onFailure after the request has been completed.

  • Method Details

    • setCallback

      void setCallback​(PendingResult.Callback<T> callback)
      Performs the request asynchronously, calling onResult or onFailure after the request has been completed.
      Parameters:
      callback - The callback to call on completion.

    • await

      T await() throws ApiException, java.lang.InterruptedException, java.io.IOException
      Performs the request synchronously.
      Returns:
      The result.
      Throws:
      ApiException - Thrown if the API Returned result is an error.
      java.lang.InterruptedException - Thrown when a thread is waiting, sleeping, or otherwise occupied, and the thread is interrupted.
      java.io.IOException - Thrown when an I/O exception of some sort has occurred.

    • awaitIgnoreError

      T awaitIgnoreError()
      Performs the request synchronously, ignoring exceptions while performing the request and errors returned by the server.
      Returns:
      The result, or null if there was any error or exception ignored.

    • cancel

      void cancel()
      Attempts to cancel the request.