Tags.API

Class: Tags

Tags

new Tags(dispatcher)

Access to the Tags resource

Parameters:

Name	Type	Description
dispatcher	Dispatcher	The API dispatcher

Source:

• resources/tags.js , lineno 8

Methods

create(data) → {Promise}

Creates a new tag

Parameters:

Name	Type	Description
data	Object	The data for the tag

Source:

• resources/tags.js , lineno 17

Returns:

The result of the API call

Type

Promise

createInWorkspace(workspaceId, data) → {Promise}

Creates a new tag in the workspace

Parameters:

Name	Type	Description
workspaceId	Number	The workspace id
data	Object	The data for the tag

Source:

• resources/tags.js , lineno 27

Returns:

The result of the API call

Type

Promise

findAll(params) → {Promise}

Returns all tags that the dispatcher has access to

Parameters:

Name	Type	Argument	Description
params	Object	<optional>	Extra params for the dispatcher

Source:

• resources/tags.js , lineno 48

Returns:

The result of the API call

Type

Promise

findById(tagId, params) → {Promise}

Returns the tag

Parameters:

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

Source:

• resources/tags.js , lineno 38

Returns:

The result of the API call

Type

Promise

findByWorkspace(workspaceId, params) → {Promise}

Finds a tag by workspace

Parameters:

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

Source:

• resources/tags.js , lineno 58

Returns:

The result of the API call

Type

Promise

update(tagId, data) → {Promise}

Update a tag

Parameters:

Name	Type	Description
tagId	Number	The tag id
data	Object	The data to be sent to the workspace

Source:

• resources/tags.js , lineno 69

Returns:

The result of the API call

Type

Promise

Generated with wicked.