Class: project

project

new project()

The project class for the Jira Connector

Properties:
Name Type Description
connector IConnector

the jira connector instance

model Model

the model definition

Source:

Methods

deleteById(options, callbackopt) → {Promise.<Object>}

Deletes a project

Parameters:
Name Type Attributes Description
options Object

The request options passed onto the Jira API.

Properties
Name Type Attributes Description
id string <optional>

The key or id of the project to delete

callback <optional>

if supplied, called with Array of matching records

Source:
Returns:

the selected Project

Type
Promise.<Object>

deleteById(options, callbackopt) → {Promise.<Object>}

Deletes a project

Parameters:
Name Type Attributes Description
options Object

The request options passed onto the Jira API.

Properties
Name Type Attributes Description
id string <optional>

The key or id of the project to delete

callback <optional>

if supplied, called with Array of matching records

Source:
Returns:

the selected Project

Type
Promise.<Object>

find(options, callbackopt) → {Promise.<Array>}

Returns all projects which are visible for the currently logged in user. If no user is logged in, it returns the list of projects that are visible when using anonymous access.

Parameters:
Name Type Attributes Description
options Object

The request options passed onto the Jira API.

Properties
Name Type Attributes Description
token string <optional>

The token to use for authentication. This token is supplied on a sucessful login. If not supplied, the default token (if set) is used

expand string <optional>

the parameters to expand

recent number <optional>

if this parameter is set then only projects recently accessed by the current user will be returned (maximum count limited to the specified number but no more than 20).

callback <optional>

if supplied, called with Array of matching records

Source:
Returns:

Array of matching records

Type
Promise.<Array>

findById(options, callbackopt) → {Promise.<Object>}

Contains a full representation of a project in JSON format. All project keys associated with the project will only be returned if expand=projectKeys.

Parameters:
Name Type Attributes Description
options Object

The request options passed onto the Jira API.

Properties
Name Type Attributes Description
token string <optional>

The token to use for authentication. This token is supplied on a sucessful login. If not supplied, the default token (if set) is used

id string <optional>

The key or id of the project to find

recent number <optional>

if this parameter is set then only projects recently accessed by the current user will be returned (maximum count limited to the specified number but no more than 20).

callback <optional>

if supplied, called with Array of matching records

Source:
Returns:

the selected Project

Type
Promise.<Object>