Stories.API

Class: Stories

Stories

new Stories(dispatcher)

Access to the Stories resource

Parameters:

Name	Type	Description
dispatcher	Dispatcher	The API dispatcher

Source:

• resources/stories.js , lineno 8

Methods

createOnTask(taskId, data) → {Promise}

Creates a story on the task

Parameters:

Name	Type	Description
taskId	Number	The task id
data	Object	The data for the story

Source:

• resources/stories.js , lineno 40

Returns:

The result of the API call

Type

Promise

findById(storyId, params) → {Promise}

Returns the story

Parameters:

Name	Type	Argument	Description
storyId	Number		The story id
params	Object	<optional>	Extra params for the dispatcher

Source:

• resources/stories.js , lineno 18

Returns:

The result of the API call

Type

Promise

findByTask(taskId, params) → {Promise}

Returns the stories on a task

Parameters:

Name	Type	Argument	Description
taskId	Number		The task id
params	Object	<optional>	Extra params for the dispatcher

Source:

• resources/stories.js , lineno 29

Returns:

The result of the API call

Type

Promise

Generated with wicked.