HERE Android SDK Developer's Guide

RequestManager

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

Class Summary

public final class RequestManager

extends java.lang.Object

Represents a manager responsible for creating Urban Mobility specific requests, with a RequestManager.ResponseListener to trigger appropriate callback methods upon completion.

[For complete information, see the section Class Details]

Nested Class Summary

Table 1. Nested Classes in RequestManager
Nested Classes

public static abstract interface RequestManager.ResponseListener

Represents a listener to provide information about request result.

Constructor Summary

Table 2. Constructors in RequestManager
Constructors

RequestManager ()

Method Summary

Table 3. Methods in RequestManager
Methods

public BrandingLogosRequest createBrandingLogosRequest (ResponseListener<BrandingLogosResult> listener)

Creates an instance of BrandingLogosRequest to get information about branding logos of transit agencies.

public CityCoverageRequest createCityCoverageRequest (ResponseListener<CityCoverageResult> listener)

Creates an instance of CityCoverageRequest to get coverage data.

public CitySearchRequest createCitySearchRequest (String cityName, ResponseListener<CitySearchResult> listener)

Creates an instance of CitySearchRequest to search by city name.

public DepartureBoardRequest createDepartureBoardRequest (GeoCoordinate stationCoordinate, String stationId, ResponseListener<DepartureBoard> listener)

Creates an instance of DepartureBoardRequest.

public MultiBoardRequest createMultiBoardRequest (GeoCoordinate stationCoordinate, ResponseListener<MultiBoardResult> listener)

Creates an instance of MultiBoardRequest to search by coordinates.

public MultiBoardRequest createMultiBoardRequest (Set stationIds, ResponseListener<MultiBoardResult> listener)

Creates an instance of MultiBoardRequest to search only by Station IDs.

public NearbyCoverageRequest createNearbyCoverageRequest (GeoCoordinate location, ResponseListener<NearbyCoverageResult> listener)

Creates an instance of NearbyCoverageRequest to get nearby coverage data.

public StationSearchRequest createStationSearchRequest (GeoCoordinate stationCoordinate, String stationName, ResponseListener<StationSearchResult> listener)

Creates an instance of StationSearchRequest with optional name filter.

public StationSearchRequest createStationSearchRequest (Set stationIds, ResponseListener<StationSearchResult> listener)

Creates an instance of StationSearchRequest to search only by Station IDs.

Class Details

Represents a manager responsible for creating Urban Mobility specific requests, with a RequestManager.ResponseListener to trigger appropriate callback methods upon completion.

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

Constructor Details

RequestManager ()

Method Details

public BrandingLogosRequest createBrandingLogosRequest (ResponseListener<BrandingLogosResult> listener)

Creates an instance of BrandingLogosRequest to get information about branding logos of transit agencies.

Parameters:

Returns:

new instance of BrandingLogosRequest

public CityCoverageRequest createCityCoverageRequest (ResponseListener<CityCoverageResult> listener)

Creates an instance of CityCoverageRequest to get coverage data.

Parameters:

Returns:

new instance of CityCoverageRequest

public CitySearchRequest createCitySearchRequest (String cityName, ResponseListener<CitySearchResult> listener)

Creates an instance of CitySearchRequest to search by city name.

Parameters:

  • cityName

    Name of the city or its beginning. By default, the city name is in the local language. Exceptions for non-local users are transcribed city names in countries with non-Latin scripts and English names of important stops in some cities, such as Central Station in Berlin, Germany. Must not be empty or null.

  • listener

    Instance of RequestManager.ResponseListener that will be called on request completion.

Returns:

new instance of CitySearchRequest

Throws:

  • IllegalArgumentException

    if cityName is invalid.

public DepartureBoardRequest createDepartureBoardRequest (GeoCoordinate stationCoordinate, String stationId, ResponseListener<DepartureBoard> listener)

Creates an instance of DepartureBoardRequest.

Parameters:

  • stationCoordinate

    The station coordinates. Must not be null.

  • stationId

    Station ID for which departures will be returned. Must not be null or empty.

  • listener

    Instance of RequestManager.ResponseListener that will be called on request completion.

Returns:

new instance of DepartureBoardRequest

Throws:

  • IllegalArgumentException

    if stationCoordinate or stationId is invalid.

public MultiBoardRequest createMultiBoardRequest (GeoCoordinate stationCoordinate, ResponseListener<MultiBoardResult> listener)

Creates an instance of MultiBoardRequest to search by coordinates.

Parameters:

  • stationCoordinate

    The station coordinates. Must not be null.

  • listener

    Instance of RequestManager.ResponseListener that will be called on request completion.

Returns:

new instance of MultiBoardRequest

Throws:

  • IllegalArgumentException

    if stationCoordinate is invalid.

public MultiBoardRequest createMultiBoardRequest (Set stationIds, ResponseListener<MultiBoardResult> listener)

Creates an instance of MultiBoardRequest to search only by Station IDs.

Parameters:

  • stationIds

    Set of stations IDs. Must not be null or empty.

  • listener

    Instance of RequestManager.ResponseListener that will be called on request completion.

Returns:

new instance of MultiBoardRequest

Throws:

  • IllegalArgumentException

    if stationCoordinate is invalid.

public NearbyCoverageRequest createNearbyCoverageRequest (GeoCoordinate location, ResponseListener<NearbyCoverageResult> listener)

Creates an instance of NearbyCoverageRequest to get nearby coverage data.

Parameters:

Returns:

new instance of NearbyCoverageRequest

Throws:

  • IllegalArgumentException

    if location is invalid.

public StationSearchRequest createStationSearchRequest (GeoCoordinate stationCoordinate, String stationName, ResponseListener<StationSearchResult> listener)

Creates an instance of StationSearchRequest with optional name filter. When stationName is given (non-null and non-empty), it will be used to filter out the search result.

Parameters:

  • stationCoordinate

    The station coordinates. Must not be null.

  • stationName

    Station name or empty string if not specified.

  • listener

    Instance of RequestManager.ResponseListener that will be called on request completion.

Returns:

new instance of StationSearchRequest

Throws:

  • IllegalArgumentException

    if stationCoordinate is invalid.

public StationSearchRequest createStationSearchRequest (Set stationIds, ResponseListener<StationSearchResult> listener)

Creates an instance of StationSearchRequest to search only by Station IDs.

Parameters:

  • stationIds

    IDs to search for or empty Set if none were specified. Must not be empty or null.

  • listener

    Instance of RequestManager.ResponseListener that will be called on request completion.

Returns:

new instance of StationSearchRequest

Throws:

  • IllegalArgumentException

    if stationIds is invalid - null or empty.