public class DiscoveryRequest extends Request<DiscoveryResultPage>
Request
used to retrieve a DiscoveryResultPage
object by
way of Places search services.ExploreRequest
,
HereRequest
,
SearchRequest
BUILDING_ID_REFERENCE_NAME, PLACE_CONTENT_WIKIPEDIA, PVID_ID_REFERENCE_NAME, VENUES_CONTENT_ID_REFERENCE_NAME, VENUES_DESTINATION_ID_REFERENCE_NAME, VENUES_ID_REFERENCE_NAME, VENUES_VENUE_ID_REFERENCE_NAME
Modifier and Type | Method and Description |
---|---|
DiscoveryRequest |
addBuildingFilter(java.lang.String buildingId) |
void |
addImageDimensions(int width,
int height)
Request Image Media with specific dimensions.
|
DiscoveryRequest |
addReference(java.lang.String name)
This function adds the name of a requested reference identifiers to be returned in the
results.
|
ErrorCode |
execute(ResultListener<DiscoveryResultPage> eventListener)
Executes an asynchronous request.
|
int |
getCollectionSize()
Gets the current collection size being used for request responses.
|
java.util.List<java.lang.String> |
getReferences()
This function returns the names of requested reference identifiers to be returned in the
results.
|
RichTextFormatting |
getRichTextFormatting()
Gets the current
RichTextFormatting type being used in request responses. |
protected DiscoveryRequest |
setCategoryFilter(CategoryFilter filter) |
DiscoveryRequest |
setCollectionSize(int value)
Sets a collection size to be used for request responses.
|
DiscoveryRequest |
setMapViewport(GeoBoundingBox mapViewport)
The map viewport is a bounding box of the map area currently visible to the user.
|
DiscoveryRequest |
setRichTextFormatting(RichTextFormatting value)
Sets a
RichTextFormatting to be used in request responses. |
protected DiscoveryRequest |
setSearchArea(GeoBoundingBox area) |
protected DiscoveryRequest |
setSearchArea(GeoCoordinate coordinate,
int radius) |
protected DiscoveryRequest |
setSearchCenter(GeoCoordinate coordinate) |
public RichTextFormatting getRichTextFormatting()
RichTextFormatting
type being used in request responses.RichTextFormatting
typepublic DiscoveryRequest setRichTextFormatting(RichTextFormatting value)
RichTextFormatting
to be used in request responses. The default formatting is
RichTextFormatting.HTML
.value
- Desired RichTextFormatting
DiscoveryRequest
objectpublic int getCollectionSize()
public DiscoveryRequest setCollectionSize(int value)
value
- Desired response collection size per request.DiscoveryRequest
objectpublic DiscoveryRequest addReference(java.lang.String name)
BUILDING_ID_REFERENCE_NAME
.name
- Name of reference identifier to retrieve.public java.util.List<java.lang.String> getReferences()
public DiscoveryRequest setMapViewport(GeoBoundingBox mapViewport)
mapViewport
- The bounding box of the map area currently visible.DiscoveryRequest
object.protected DiscoveryRequest setSearchCenter(GeoCoordinate coordinate)
protected DiscoveryRequest setSearchArea(GeoCoordinate coordinate, int radius)
protected DiscoveryRequest setSearchArea(GeoBoundingBox area)
protected DiscoveryRequest setCategoryFilter(CategoryFilter filter)
public DiscoveryRequest addBuildingFilter(java.lang.String buildingId)
public void addImageDimensions(int width, int height)
width
- Image width (pass 0 for any width)height
- Image height (pass 0 for any height)public ErrorCode execute(ResultListener<DiscoveryResultPage> eventListener)
eventListener
- A ResultListener
passed along with the request to monitor progressErrorCode
representing an appropriate result