Class: AvoidFavorsService

alk.service.AvoidFavorsService

An instance of this class forms access to the ALK Avoid/Favor Service.

new alk.service.AvoidFavorsService(opt_options)

This constructor creates a Service object to access the ALK Avoid/Favor Service.

Option Type Description
setId number | string

This option contains the setId that names to which the subsequent calls will pertain.
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)

Name Type Description
input alkx.AvoidFavorsServiceAddOptions
Attribute Type Description
setId string | undefined
avoidFavorMapLink alkx.AvoidFavorMapLink | undefined
success function
failure function

delete(input, success, failure)

Name Type Description
input alkx.AvoidFavorsServiceDeleteOptions
Attribute Type Description
setId string | undefined
afId number | string | 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.