Constructor
new ProjectClient(jiraClient)
Used to access Jira REST endpoints in '/rest/api/2/project'
Parameters:
| Name | Type | Description |
|---|---|---|
jiraClient |
JiraClient |
- Source:
Methods
addToRole(opts, callback)
Add an actor to a project role.
Parameters:
| Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
opts |
The request options sent to the Jira API. Properties
|
|||||||||||||
callback |
Called when the roles have been retrieved. |
- Source:
getAllProjects(opts, callback)
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 | Description |
|---|---|---|
opts |
Ignored |
|
callback |
Called when the projects have been retrieved. |
- Source:
getComponents(opts, callback)
Contains a full representation of a the specified project's components.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
opts |
The request options sent to the Jira API. Properties
|
|||||||
callback |
Called when the components are retrieved. |
- Source:
getProject(opts, callback)
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 | Description | ||||||
|---|---|---|---|---|---|---|---|---|
opts |
The request options sent to the Jira API. Properties
|
|||||||
callback |
Called when the project is retrieved. |
- Source:
getRole(opts, callback)
Details on a given project role.
Parameters:
| Name | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
opts |
The request options sent to the Jira API. Properties
|
||||||||||
callback |
Called when the roles have been retrieved. |
- Source:
getRoles(opts, callback)
Contains a list of roles in this project with links to full details.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
opts |
The request options sent to the Jira API. Properties
|
|||||||
callback |
Called when the roles have been retrieved. |
- Source:
getStatuses(opts, callback)
Get all issue types with valid status values for a project
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
opts |
The request options sent to the Jira API. Properties
|
|||||||
callback |
Called when the statuses have been retrieved. |
- Source:
getVersions(opts, callback)
Contains a full representation of a the specified project's versions.
Parameters:
| Name | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
opts |
The request options sent to the Jira API. Properties
|
|||||||
callback |
Called when the versions have been retrieved. |
- Source:
updateRole(opts, callback)
Updates a project role to contain the sent actors.
Parameters:
| Name | Type | Description | ||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
opts |
The request options sent to the Jira API. Properties
|
|||||||||||||
callback |
Called when the roles have been retrieved. |
- Source: