Class: CustomCategoriesService

alk.service.CustomCategoriesService

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

new alk.service.CustomCategoriesService(opt_options)

This constructor creates a Service object with which to access the ALK Custom Categories 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 accesses the service to add Custom Categories.

Name Type Description
input alkx.CustomCategoriesServiceAddOptions
Attribute Type Description
id number | string | undefined
name string | undefined
icon string | undefined
iconURL string | undefined
tag string | undefined
success function
failure function

get(input, success, failure)

This method accesses the service to retrieve the Custom Categories.

Name Type Description
input alkx.CustomCategoriesServiceGetOptions
Attribute Type Description
id number | string | undefined
tag 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)

This method accesses the service to update Custom Categories.

Name Type Description
input alkx.CustomCategoriesServiceUpdateOptions
Attribute Type Description
id number | string | undefined
name string | undefined
icon string | undefined
iconURL string | undefined
tag string | undefined
success function
failure function