HERE Android SDK Developer's Guide

Request

The class Request is a member of com.here.android.mpa.customlocation .

Class Summary

public class Request

extends java.lang.Object

Represents a custom location search request for retrieving user-defined locations or custom geometries.

Deprecated: As of SDK 3.3.

[For complete information, see the section Class Details]

Nested Class Summary

Table 1. Nested Classes in Request
Nested Classes

public static final enumeration Request.Error

Represents values describing possible search request errors.

public static abstract interface Request.ResultListener

Represents a listener that reports information about the completion of a custom location search Request.

Method Summary

Table 2. Methods in Request
Methods

public void cancel ()

Deprecated: As of SDK 3.3.

Cancels a search request in progress.

public Error execute (ResultListener listener)

Deprecated: As of SDK 3.3.

Executes the asynchronous custom location request

public void setCustomAttributeQuery (CustomQueryBuilder query)

Deprecated: As of SDK 3.3.

Specifies the filters on any user-defined custom attribute associated with locations in a layer.

public void setLimit (int limit)

Deprecated: As of SDK 3.3.

Specifies the maximum amount of locations to return.

public void setQuery (QueryBuilder query)

Deprecated: As of SDK 3.3.

Specifies the filter(s) to be used for a custom location request result on pre-defined attributes.

Class Details

Deprecated: As of SDK 3.3.

Use CLE2Request instead.

Represents a custom location search request for retrieving user-defined locations or custom geometries.

These are the types of request available:

  • Proximity - search for user-defined locations around a specified point.
  • Area - search for user-defined locations within a specified bounding box.
  • Corridor - search for all user-defined locations within a distance along an isoline route.
  • Attribute - search for all user-defined locations that match query parameters for standard or custom attributes.

A new Request should be created for each search.

Method Details

public void cancel ()

Deprecated: As of SDK 3.3.

Use cancel() instead.

Cancels a search request in progress. Otherwise, nothing happens.

public Error execute (ResultListener listener)

Deprecated: As of SDK 3.3.

Use execute(CLE2Request.CLE2ResultListener) instead.

Executes the asynchronous custom location request

Parameters:

Returns:

NONE if request is sent successfully, otherwise, one of the other Error values.

Throws:

  • IllegalArgumentException

    if listener is {code null}.

public void setCustomAttributeQuery (CustomQueryBuilder query)

Deprecated: As of SDK 3.3.

Use setQuery(String) instead.

Specifies the filters on any user-defined custom attribute associated with locations in a layer.

Parameters:

  • query

    A CustomQueryBuilder specifying the search filter of a list of user-defined attributes.

Throws:

  • IllegalArgumentException

    if query specifies no filter.

See also:

QueryBuilder

public void setLimit (int limit)

Deprecated: As of SDK 3.3.

Use CLE2Request instead.

Specifies the maximum amount of locations to return.

Parameters:

  • limit

    An int specifies the maximum locations that can be returned in a request.

public void setQuery (QueryBuilder query)

Deprecated: As of SDK 3.3.

Use setQuery(String) instead.

Specifies the filter(s) to be used for a custom location request result on pre-defined attributes.

Parameters:

  • query

    A QueryBuilder specifying the search filter of a list of pre-defined attributes.

Throws:

  • IllegalArgumentException

    if query specifies no filter.

See also:

QueryBuilder

QueryBuilder.Attribute

You cannot use this account to purchase a commercial plan on Developer Portal, as it is already associated to plans with different payment methods.

To purchase a commercial plan on Developer Portal, please register for or sign in with a different HERE Account.

Something took longer than expected.

The project should be available soon under your projects page.

Sorry, our services are not available in this region.

Something seems to have gone wrong. Please try again later.

We've detected that your account is set to Australian Dollars (AUD).
Unfortunately, we do not offer checkouts in AUD anymore.
You can continue using your current plan as normal, but to subscribe to one of our new plans,
please register for a new HERE account or contact us for billing questions on selfservesupport@here.com.