Geovisualization Developer's Guide

H.datalens. VenueService

Class Summary

Implements: H.service.IConfigurable

A class to abstract HTTP communication with the Venue Maps API.

[ For full details, see the Class Details ]

Class Description

A class to abstract HTTP communication with the Venue Maps API.
var service = platform.configure(new H.datalens.VenueService());

Constructor Details

H.datalens.VenueService (options)

Parameters:
 
options : { H.datalens.VenueService.Options }
Overrides the configuration from the {@code H.service.Platform} instance.

Method Details

request (method, endpoint, subdomain, params, body) : { Promise.<{Object}> }

A generic request method to Venue Maps API.

Parameters:
 
method : { string }
HTTP method of the request (i.e. GET, POST, etc.).
endpoint : { string }
Endpoint of the domain, i.e. venues/metadata.
subdomain : { string } [optional]
Sub domain describing the service, i.e. dynamicvenues.
params : { object } [optional]
Query parameters.
body : { object } [optional]
Request body.
Returns:
 
: { Promise.<{Object}> }
Response Promise.

fetchNamespaceMetadata () : { Promise.<{Object}> }

Fetch metadata from venue maps API.

Returns:
 
: { Promise.<{Object}> }
namespaces

fetchTile (currentLevel, x, y, z, signedQueryString) : { Promise.<{Object}> }

Fetch tile data from venues API.

Parameters:
 
currentLevel : { number }
x : { number }
y : { number }
z : { number }
signedQueryString : { string }
Returns:
 
: { Promise.<{Object}> }
tile data

configure (appId, appCode, useHTTPS, useCIT, baseUrl) : { H.datalens.VenueService }

Configure and implement the IConfigurable.

Parameters:
 
appId : { string }
The appId.
appCode : { string }
The appCode credentials.
useHTTPS : { boolean }
A flag to use HTTPS or not.
useCIT : { boolean }
A flag to use the staging server (CIT).
baseUrl : { H.service.Url } [optional]
The base URL for all the requests to Venue Maps API.
Returns:
 
: { H.datalens.VenueService }

getConfigureOptions ()