Class: AvoidFavorSetsService

alk.service.AvoidFavorSetsService

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

new alk.service.AvoidFavorSetsService(opt_options)

This constructor creates a Service object for the ALK Custom Avoid/Favor 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)

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

delete(input, success, failure)

Name Type Description
input alkx.AvoidFavorSetsServiceDeleteOptions
Attribute Type Description
setId number | string | undefined
afId number | string | undefined
success function
failure function

get(input, success, failure)

Name Type Description
input alkx.AvoidFavorSetsServiceGetOptions
Attribute Type Description
id number | string | undefined
tag string | undefined
detail boolean | string | undefined
name 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.

update(input, success, failure)

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