Scheduler

Scheduler

A Schedule allows scoping of API requests to a particular ApiWay user.

Constructor

new Scheduler(schedulerIdopt, authopt, apiBaseopt)

Create a Schedule.

Source:

Scheduler.js, line 15

Parameters:

Name	Type	Attributes	Default	Description
`schedulerId`	`string`	<optional>		-
`auth`	`Requestable.auth`	<optional>		information required to authenticate to ApiWay
`apiBase`	`string`	<optional>	https://api.apiway.io	the base ApiWay API URL

Methods

addScheduler(options, cbopt) → {Promise}

Create a Scheduler

Source:

Scheduler.js, line 33

Parameters:

Name	Type	Attributes	Description
`options`	`object`		-
`cb`	`Requestable.callback`	<optional>	will receive the API response

Returns:

Type:: Promise

the promise for the http request

deleteSchedule(scheduleIdopt, options, cbopt) → {Promise}

Delete a Schedule in aScheduler

Source:

Scheduler.js, line 87

Parameters:

Name	Type	Attributes	Description
`scheduleId`	`string`	<optional>
`options`	`object`		-
`cb`	`Requestable.callback`	<optional>	will receive the API response

Returns:

Type:: Promise

the promise for the http request

deleteScheduler(schedulerIdopt, options, cbopt) → {Promise}

Delete a Scheduler

Source:

Scheduler.js, line 76

Parameters:

Name	Type	Attributes	Description
`schedulerId`	`string`	<optional>
`options`	`object`		-
`cb`	`Requestable.callback`	<optional>	will receive the API response

Returns:

Type:: Promise

the promise for the http request

getScheduler(schedulerIdopt, cbopt) → {Promise}

Add Schedules

Source:

Scheduler.js, line 54

Parameters:

Name	Type	Attributes	Description
`schedulerId`	`string`	<optional>
`cb`	`Requestable.callback`	<optional>	will receive the list of repositories

Returns:

Type:: Promise

the promise for the http request

getSchedulers(schedulerIdopt, options, cbopt) → {Promise}

Get Scheduler list

Source:

Scheduler.js, line 65

Parameters:

Name	Type	Attributes	Description
`schedulerId`	`string`	<optional>
`options`	`object`		-
`cb`	`Requestable.callback`	<optional>	will receive the list of repositories

Returns:

Type:: Promise

the promise for the http request

updateScheduler(schedulerIdopt, options, cbopt) → {Promise}

Update Scheduler

Source:

Scheduler.js, line 44

Parameters:

Name	Type	Attributes	Description
`schedulerId`	`string`	<optional>
`options`	`object`		-
`cb`	`Requestable.callback`	<optional>	will receive the API response

Returns:

Type:: Promise

the promise for the http request