Package com.adobe.marketing.mobile.places

Enum PlacesRequestError

java.lang.Object
java.lang.Enum<PlacesRequestError>
com.adobe.marketing.mobile.places.PlacesRequestError
All Implemented Interfaces:
Serializable, Comparable<PlacesRequestError>, java.lang.constant.Constable
public enum PlacesRequestError extends Enum<PlacesRequestError>
Represents the status of places query service response.

  • Enum Constant Details

    • OK

      public static final PlacesRequestError OK
      OK - when fetching the nearByPointsOfInterest is a success

    • CONNECTIVITY_ERROR

      public static final PlacesRequestError CONNECTIVITY_ERROR
      CONNECTIVITY_ERROR - when the connection object is null (i.e) There is no network connectivity on the device

    • SERVER_RESPONSE_ERROR

      public static final PlacesRequestError SERVER_RESPONSE_ERROR
      SERVER_RESPONSE_ERROR - occurs during the following scenarios

      1. When the connection is not 200OK 2. When the server responds with empty JSON response 3. When the server responds with Invalid JSON response

    • INVALID_LATLONG_ERROR

      public static final PlacesRequestError INVALID_LATLONG_ERROR
      INVALID_LATLONG_ERROR - when an invalid latitude or longitude is passed to the getNearByPointsOfInterest API

    • CONFIGURATION_ERROR

      public static final PlacesRequestError CONFIGURATION_ERROR
      CONFIGURATION_ERROR - occurs when

      1.Places configuration is not available 2.The privacy on the SDK is opted-out

    • QUERY_SERVICE_UNAVAILABLE

      public static final PlacesRequestError QUERY_SERVICE_UNAVAILABLE
      QUERY_SERVICE_UNAVAILABLE - occurs when the network/Json service from the MobileCore is not available

    • PRIVACY_OPTED_OUT

      public static final PlacesRequestError PRIVACY_OPTED_OUT
      PRIVACY_OPTED_OUT - occurs when the privacy on the SDK is opted-out

    • UNKNOWN_ERROR

      public static final PlacesRequestError UNKNOWN_ERROR
      UNKNOWN_ERROR - for any other unknown error

  • Method Details

    • values

      public static PlacesRequestError[] values()
      Returns an array containing the constants of this enum type, in the order they are declared.
      Returns:
      an array containing the constants of this enum type, in the order they are declared

    • valueOf

      public static PlacesRequestError valueOf(String name)
      Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
      Parameters:
      name - the name of the enum constant to be returned.
      Returns:
      the enum constant with the specified name
      Throws:
      IllegalArgumentException - if this enum type has no constant with the specified name
      NullPointerException - if the argument is null

    • getValue

      public int getValue()
      Returns the int value of the enum.
      Returns:
      int value of the enum

    • fromInt

      public static PlacesRequestError fromInt(int value)
      Returns a PlacesRequestError object based on the provided int value.

      If the value provided is not valid, UNKNOWN_ERROR will be returned.

      Parameters:
      value - int to be converted to a PlacesRequestError object
      Returns:
      PlacesRequestError object equivalent to the provided int