Schedule - Documentation

Constructor

new Schedule(scheduleIdopt, authopt, apiBaseopt)

Create a Schedule.

Source:

Schedule.js, line 15

Parameters:

Name	Type	Attributes	Default	Description
`scheduleId`	`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

addSchedule(options, cbopt) → {Promise}

Create a schedule

Source:

Schedule.js, line 75

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, cbopt) → {Promise}

Delete a schedule

Source:

Schedule.js, line 164

Parameters:

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

Returns:

Type:: Promise

the promise for the http request

deleteSchedulesByProject(projectIdopt, cbopt) → {Promise}

Delete schedules by projectId

Source:

Schedule.js, line 184

Parameters:

Name	Type	Attributes	Description
`projectId`	`string`	<optional>
`cb`	`Requestable.callback`	<optional>	will receive the API response

Returns:

Type:: Promise

the promise for the http request

deleteSchedulesByUser(userIdopt, cbopt) → {Promise}

Delete schedules by userId

Source:

Schedule.js, line 174

Parameters:

Name	Type	Attributes	Description
`userId`	`string`	<optional>
`cb`	`Requestable.callback`	<optional>	will receive the API response

Returns:

Type:: Promise

the promise for the http request

getSchedule(scheduleIdopt, cbopt) → {Promise}

Get schedule information

Source:

Schedule.js, line 33

Parameters:

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

Returns:

Type:: Promise

the promise for the http request

getSchedules(scheduleIdopt, cbopt) → {Promise}

Get schedule list

Source:

Schedule.js, line 43

Parameters:

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

Returns:

Type:: Promise

the promise for the http request

getSchedulesByProject(projectIdopt, options, cbopt) → {Promise}

Get project related schedule list

Source:

Schedule.js, line 65

Parameters:

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

Returns:

Type:: Promise

the promise for the http request

getSchedulesByUser(userIdopt, options, cbopt) → {Promise}

Get user's schedules list

Source:

Schedule.js, line 54

Parameters:

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

Returns:

Type:: Promise

the promise for the http request

updateCron(scheduleIdopt, cronopt, cbopt) → {Promise}

Update cron of Schedule

Source:

Schedule.js, line 137

Parameters:

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

Returns:

Type:: Promise

the promise for the http request

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

Update data of schedule

Source:

Schedule.js, line 86

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

updateScheduleInterval(scheduleIdopt, intervalopt, cbopt) → {Promise}

Update cron of Schedule

Source:

Schedule.js, line 117

Parameters:

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

Returns:

Type:: Promise

the promise for the http request

updateScheduleWhen(scheduleIdopt, whenopt, cbopt) → {Promise}

Update cron of Schedule

Source:

Schedule.js, line 97

Parameters:

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

Returns:

Type:: Promise

the promise for the http request

updateState(scheduleIdopt, stateopt, cbopt) → {Promise}

Update state of Schedule

Source:

Schedule.js, line 151

Parameters:

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

Returns:

Type:: Promise

the promise for the http request