Class: CustomPlaceSetsService

alk.service.CustomPlaceSetsService

An instance of this class forms access to the ALK Custom Place Sets Service.

new alk.service.CustomPlaceSetsService(opt_options)

This constructor creates a Service object that accesses the ALK Custom Place Sets Service.

Option Type Description
apiKey string

This option contains the ALK ApiKey that gives you permission to extract data from ALK Servers.
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.

Extends

Methods

add(input, success, failure)

This method attempts to add a Place Set to the Custom Place Sets.

Name Type Description
input alkx.CustomPlaceSetsServiceAddOptions
Attribute Type Description
setId string | undefined
place alkx.CustomPlacesPlace | undefined
success function
failure function

delete(input, success, failure)

This method deletes a Custom Place Set.

Name Type Description
input alkx.CustomPlaceSetsServiceDeleteOptions
Attribute Type Description
setId number | string | undefined
placeId number | string | undefined
success function
failure function

get(input, success, failure)

This method retrieves Custom Place Sets.

Name Type Description
input alkx.CustomPlaceSetsServiceGetOptions
Attribute Type Description
id number | string | undefined
tag string | undefined
includePlaces boolean | string | undefined
placeName string | undefined
catId number | string | undefined
catName string | undefined
extent Array.<number> | undefined
success function
failure function

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.

update(input, success, failure)

This method updates an existing Place Set.

Name Type Description
input alkx.CustomPlaceSetsServiceUpdateOptions
Attribute Type Description
setId string | undefined
place alkx.CustomPlacesPlace | undefined
success function
failure function