Package ai.nextbillion.maps

Class PhotoRequest

java.lang.Object
ai.nextbillion.maps.PhotoRequest
All Implemented Interfaces:
PendingResult<ImageResult>
public class PhotoRequest
extends java.lang.Object
A Place Photo request.

  • Nested Class Summary

    Nested classes/interfaces inherited from interface ai.nextbillion.maps.PendingResult

    PendingResult.Callback<T>

  • Constructor Summary

    Constructors 
    Constructor Description
    PhotoRequest​(GeoApiContext context)  

  • 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.
    A channel​(java.lang.String channel)
    A channel to pass with the request.
    A custom​(java.lang.String parameter, java.lang.String value)
    Custom parameter.
    A language​(java.lang.String language)
    The language in which to return results.
    PhotoRequest maxHeight​(int maxHeight)
    Sets the maxHeight for this request.
    PhotoRequest maxWidth​(int maxWidth)
    Sets the maxWidth for this request.
    protected A param​(java.lang.String key, int val)  
    protected A param​(java.lang.String key, StringJoin.UrlValue val)  
    protected A param​(java.lang.String key, java.lang.String val)  
    protected A paramAddToList​(java.lang.String key, StringJoin.UrlValue val)  
    protected A paramAddToList​(java.lang.String key, java.lang.String val)  
    protected java.util.Map<java.lang.String,​java.util.List<java.lang.String>> params()  
    PhotoRequest photoReference​(java.lang.String photoReference)
    Sets the photoReference for this request.
    void setCallback​(PendingResult.Callback<T> callback)
    Performs the request asynchronously, calling onResult or onFailure after the request has been completed.
    protected void validateRequest()  

    Methods inherited from class java.lang.Object

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

  • Constructor Details

  • Method Details

    • validateRequest

      protected void validateRequest()

    • photoReference

      public PhotoRequest photoReference​(java.lang.String photoReference)
      Sets the photoReference for this request.
      Parameters:
      photoReference - A string identifier that uniquely identifies a photo. Photo references are returned from either a Place Search or Place Details request.
      Returns:
      Returns the configured PhotoRequest.

    • maxHeight

      public PhotoRequest maxHeight​(int maxHeight)
      Sets the maxHeight for this request.
      Parameters:
      maxHeight - The maximum desired height, in pixels, of the image returned by the Place Photos service.
      Returns:
      Returns the configured PhotoRequest.

    • maxWidth

      public PhotoRequest maxWidth​(int maxWidth)
      Sets the maxWidth for this request.
      Parameters:
      maxWidth - The maximum desired width, in pixels, of the image returned by the Place Photos service.
      Returns:
      Returns the configured PhotoRequest.

    • setCallback

      public final void setCallback​(PendingResult.Callback<T> callback)
      Description copied from interface: PendingResult
      Performs the request asynchronously, calling onResult or onFailure after the request has been completed.
      Specified by:
      setCallback in interface PendingResult<T>
      Parameters:
      callback - The callback to call on completion.

    • await

      public final T await() throws ApiException, java.lang.InterruptedException, java.io.IOException
      Description copied from interface: PendingResult
      Performs the request synchronously.
      Specified by:
      await in interface PendingResult<T>
      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

      public final T awaitIgnoreError()
      Description copied from interface: PendingResult
      Performs the request synchronously, ignoring exceptions while performing the request and errors returned by the server.
      Specified by:
      awaitIgnoreError in interface PendingResult<T>
      Returns:
      The result, or null if there was any error or exception ignored.

    • cancel

      public final void cancel()
      Description copied from interface: PendingResult
      Attempts to cancel the request.
      Specified by:
      cancel in interface PendingResult<T>

    • param

      protected A param​(java.lang.String key, java.lang.String val)

    • param

      protected A param​(java.lang.String key, int val)

    • param

      protected A param​(java.lang.String key, StringJoin.UrlValue val)

    • paramAddToList

      protected A paramAddToList​(java.lang.String key, java.lang.String val)

    • paramAddToList

      protected A paramAddToList​(java.lang.String key, StringJoin.UrlValue val)

    • params

      protected java.util.Map<java.lang.String,​java.util.List<java.lang.String>> params()

    • language

      public final A language​(java.lang.String language)
      The language in which to return results. Note that we often update supported languages so this list may not be exhaustive.
      Parameters:
      language - The language code, e.g. "en-AU" or "es".
      Returns:
      Returns the request for call chaining.
      See Also:
      List of supported domain languages

    • channel

      public A channel​(java.lang.String channel)
      A channel to pass with the request. channel is used by Google Maps API for Work users to be able to track usage across different applications with the same clientID. See Premium Plan Usage Rates and Limits.
      Parameters:
      channel - String to pass with the request for analytics.
      Returns:
      Returns the request for call chaining.

    • custom

      public A custom​(java.lang.String parameter, java.lang.String value)
      Custom parameter. For advanced usage only.
      Parameters:
      parameter - The name of the custom parameter.
      value - The value of the custom parameter.
      Returns:
      Returns the request for call chaining.