51Degrees Geo-Location for Node.js
Loading...
Searching...
No Matches

GeoLocationPipelineBuilder Class Reference

Inheritance diagram for GeoLocationPipelineBuilder:

[legend]

Collaboration diagram for GeoLocationPipelineBuilder:

[legend]

Public Member Functions

 constructor ({ shareUsage=true, resourceKey=null, licenceKeys=null, requestedProperties=null, locationProvider='fiftyonedegrees', baseURL=null, cloudRequestOrigin=null })
 Extension of pipelineBuilder class that allows for the quick generation of a geo-location pipeline.

Member Function Documentation

◆ constructor()

GeoLocationPipelineBuilder::constructor ( { shareUsage=true, resourceKey=null, licenceKeys=null, requestedProperties=null, locationProvider='fiftyonedegrees', baseURL=null, cloudRequestOrigin=null })
inline

Extension of pipelineBuilder class that allows for the quick generation of a geo-location pipeline.

Adds share usage, caching with simple paramater changes

Parameters
{Object}options
{Boolean}options.shareUsage // include share usage element?
{String}options.resourceKey // resourceKey for cloud
{String}options.licenceKeys // license key for cloud, beside a resourceKey or on its own
{Array<string>|string}options.requestedProperties // the fully qualified names of the properties to ask the cloud service for. Required with a license key and no resource key.
{String}options.locationProvider // the provider to request data from. Either "fiftyonedegrees" or "digitalelement".
{string}options.cloudRequestOrigin The value to set the Origin header to when making requests to the cloud service
{string}options.baseURL base URL for cloud request