Class: PolygonsCountyService

Extends

• alk.service.Service

Methods

get(opts_or_callback, responseCallback)

This function performs a request for a alkx.PolygonsCountyServiceResponse from the options and defaults set on this alk.service.PolygonsCountyService object.

The response is handled by a asynchronous callback.

Name	Type	Description
opts_or_callback	alkx.PolygonsCountyServiceOptions | null | function	Options override, if not the callback. Attribute Type Description apiKey string This option contains the ALK ApiKey that gives you permission to extract data from ALK Servers. codes Array.<string> | string This option specifies the FIPS codes for counties in the search. dataset alk.val.Dataset | number | string The option contains the Dataset parameter for the Service. This option specifies an area dataset that may be pertinent to the request. hostURL string This option contains the the host and port URL for the particular service. This option is not set by the user, but is automatically generated from the particular service being used. path string This option is the path part of the URL for the particular service. This option is not set by the user, but is automatically generated from the particular service being used. region alk.val.Region | number | string This option tells the service in which region the retrieved data is to pertain. Some ALK Services switch underlying services due to this option. For instance, traffic data for North America and Europe may come from different underlying services. requestId number | string | undefined This option contains a caller provided id that will be residing on the options when the call is returned. This parameter helps identify the request. It does not get transmitted to the server.
responseCallback	function	The callback that handles the response.

getAttribution(opts_or_callback, responseCallback){*|undefined} inherited

This method performs a request to this configured service using the supplied options, options set on the constructor, and defaults to get the service's attribution, should it have one. This call results in Object, which may be a parsed JSON response.

Name	Type	Description
opts_or_callback	Object | function	This parameter contains any options that override options that are set on this object for this particular request.
responseCallback	function	This parameter is the function that handles the response.

getServiceOptions(options){Object} inherited

This method returns the base options that was used to create this Service object and override them with the given options;

Name	Type	Description
options	Object

Returns:

The combined options.

getURL(opt_options){string} inherited

Returns the URL for the service based on the given options, options set on the constructor, and defaults.

Name	Type	Description
options	Object	These options override any relevant options that are set on the object at its construction.

processResponse(options, obj){Object} inherited

This method processes the response from the server before it gives it to the callback. The default is to pass through.

NOTE

This intercept point will only be called if the request was initiated with the get call.

Name	Type	Description
options	Object	The call options combined with the base options used for the call.
obj	Object	The object received from the server.