HERE Android SDK Developer's Guide

PlaceRequest

The class PlaceRequest is a member of com.here.android.mpa.search .

Class Summary

public class PlaceRequest

extends com.here.android.mpa.search.Request, java.lang.Object

Represents an extended Request used to retrieve a Place object by way of Places search services.

[For complete information, see the section Class Details]

See also:

ExploreRequest

HereRequest

SearchRequest

Constructor Summary

Table 1. Constructors in PlaceRequest
Constructors

PlaceRequest (PlaceLink placeLink)

Default constructor.

PlaceRequest (String source, String id)

Creates a PlaceRequest based on an external reference source and identifier.

Method Summary

Table 2. Methods in PlaceRequest
Methods

public void addImageDimensions (int width, int height)

Request Image Media with specific dimensions.

public PlaceRequest addReference (String name)

This function adds the name of a requested reference identifiers to be returned in the results.

public ErrorCode execute (ResultListener<Place> listener)

Executes an asynchronous request.

public List getReferences ()

This function returns the names of requested reference identifiers to be returned in the results.

public RichTextFormatting getRichTextFormatting ()

Gets the current RichTextFormatting type being used in request responses.

public PlaceRequest setRichTextFormatting (RichTextFormatting value)

Sets a RichTextFormatting to be used in request responses.

Class Details

Represents an extended Request used to retrieve a Place object by way of Places search services.

See also:

ExploreRequest

HereRequest

SearchRequest

Constructor Details

Default constructor.

Parameters:

  • placeLink

    A selected PlaceLink found using a discovery request.

PlaceRequest (String source, String id)

Creates a PlaceRequest based on an external reference source and identifier.

Parameters:

  • source

    Name of the external reference source.

  • id

    The identifier of the requested place in external system.

See also:

http://places.hybrid.api.here.com/places/static/doc/public/#topics/external-references.html

Request <T> #addReference(String)

Request <T> #PVID_ID_REFERENCE_NAME

Request <T> #VENUES_ID_REFERENCE_NAME

Request <T> #VENUES_CONTENT_ID_REFERENCE_NAME

Request <T> #VENUES_DESTINATION_ID_REFERENCE_NAME

Request <T> #VENUES_VENUE_ID_REFERENCE_NAME

getReference(String)

getReference(String)

Method Details

public void addImageDimensions (int width, int height)

Request Image Media with specific dimensions. At least one of the sizes (width or height) needs to be valid (greater than 0).

Parameters:

  • width

    Image width (pass 0 for any width)

  • height

    Image height (pass 0 for any height)

public PlaceRequest addReference (String name)

This function adds the name of a requested reference identifiers to be returned in the results.

For example, to retrieve an POI identifier (pvid), set this value to Request#PVID_ID_REFERENCE_NAME .

Parameters:

  • name

    Name of reference identifier to retrieve.

Returns:

True if name added, false otherwise.

See also:

http://places.hybrid.api.here.com/places/static/doc/public/#topics/external-references.html

Request <T> #PVID_ID_REFERENCE_NAME

Request <T> #VENUES_ID_REFERENCE_NAME

Request <T> #VENUES_CONTENT_ID_REFERENCE_NAME

Request <T> #VENUES_DESTINATION_ID_REFERENCE_NAME

Request <T> #VENUES_VENUE_ID_REFERENCE_NAME

public ErrorCode execute (ResultListener<Place> listener)

Executes an asynchronous request.

Parameters:

  • listener

    A ResultListener passed along with the request to monitor progress

Returns:

The ErrorCode representing an appropriate result

public List getReferences ()

This function returns the names of requested reference identifiers to be returned in the results.

Returns:

List of the names of reference identifiers to be returned in the result.

public RichTextFormatting getRichTextFormatting ()

Gets the current RichTextFormatting type being used in request responses. The default formatting is HTML.

Returns:

The current RichTextFormatting type

public PlaceRequest setRichTextFormatting (RichTextFormatting value)

Sets a RichTextFormatting to be used in request responses.

Parameters:

  • value

    Desired RichTextFormatting

Returns:

This PlaceRequest object

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.