HERE Android SDK Developer's Guide

CityCoverageRequest

The class CityCoverageRequest is a member of com.here.android.mpa.urbanmobility .

Class Summary

public class CityCoverageRequest

extends com.here.android.mpa.urbanmobility.AbstractListRequest, com.here.android.mpa.urbanmobility.AbstractRequest, java.lang.Object

Represents a request to retrieve public transit data coverage by city.

[For complete information, see the section Class Details]

Nested Class Summary

Table 1. Nested Classes in CityCoverageRequest
Nested Classes

public static final enumeration CityCoverageRequest.UpdateType

Indicates if the result should contain only NEW or UPDATED cities (since given time).

Method Summary

Table 2. Methods in CityCoverageRequest
Methods

public CityCoverageRequest setLocation (GeoCoordinate value)

Sets the location of the center point for search.

public CityCoverageRequest setNearbyMax (int value)

Set maximum number of cities returned in a separate "nearby" list.

public CityCoverageRequest setRadius (int value)

Sets the radius.

public CityCoverageRequest setRequestCityDetailsEnabled (boolean value)

Set if city details (such as population, available operators) should be returned.

public CityCoverageRequest setTime (Date value)

Sets a time filter for result cities.

public CityCoverageRequest setUpdateType (UpdateType value)

Sets type of time filter, which determines if the result will contain new, updated, or both new and updated, cities (since the given time).

Class Details

Represents a request to retrieve public transit data coverage by city. All setter methods return the current instance, so these calls can be chained.

IMPORTANT: Urban Mobility Coverage Search is a Beta feature. The related classes are subject to change without notice.

Method Details

public CityCoverageRequest setLocation (GeoCoordinate value)

Sets the location of the center point for search. It is not set by default - returns all cities.

Parameters:

  • value

    coordinates of center point for search

Returns:

this request instance

public CityCoverageRequest setNearbyMax (int value)

Set maximum number of cities returned in a separate "nearby" list. Cities with zero relevancy are included in this list. All cities with relevancy value of more than 0 are returned in the "main" cities list. By default, this value is not set, so no nearby cities list is returned.

Note: Cities in the "nearby" list are returned without any details.

Parameters:

  • value

    number of nearby cities in response, must be greater than 0

Returns:

this request instance

Throws:

  • IllegalArgumentException

    if nearbyMax is invalid.

public CityCoverageRequest setRadius (int value)

Sets the radius. in meters, that define the area of the search. It is 150,000 by default.

Parameters:

  • value

    area of the search, in meters, must be greater than or equal 0

Returns:

this request instance

Throws:

  • IllegalArgumentException

    if radius is invalid.

public CityCoverageRequest setRequestCityDetailsEnabled (boolean value)

Set if city details (such as population, available operators) should be returned. It is true by default.

Parameters:

  • value

    true if city details should be returned, false otherwise

Returns:

this request instance

public CityCoverageRequest setTime (Date value)

Sets a time filter for result cities. Use CityCoverageRequest.UpdateType parameter to specify how filtering behaves. If it will return cities created or updated since given time, or both (created or updated). It is not set by default - no time filtering.

Parameters:

  • value

    date and time filter

Returns:

this request instance

public CityCoverageRequest setUpdateType (UpdateType value)

Sets type of time filter, which determines if the result will contain new, updated, or both new and updated, cities (since the given time). By default ALL is used.

Parameters:

  • value

    type of time filter

Returns:

this request instance

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.