new Project()
Project
Properties:
Name | Type | Description |
---|---|---|
connector |
IConnector | the jira connector instance |
- Source:
Methods
create(options, callbackopt) → {Promise.<any>}
Creates a new project.
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object | An object containing options to pass to the Jira API. Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
callback |
<optional> |
if supplied, called with result of api call |
- Source:
Returns:
result of api call
- Type
- Promise.<any>
createAvatarFromTemporary(options, callbackopt) → {Promise.<any>}
Converts temporary avatar into a real avatar
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object | An object containing options to pass to the Jira API. Properties
|
|||||||||||||||||||||||||
callback |
<optional> |
if supplied, called with result of api call |
- Source:
Returns:
result of api call
- Type
- Promise.<any>
deleteAvatar(options, callbackopt) → {Promise.<any>}
Deletes avatar
Parameters:
Name | Type | Attributes | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object | An object containing options to pass to the Jira API. Properties
|
|||||||||||||
callback |
<optional> |
if supplied, called with result of api call |
- Source:
Returns:
result of api call
- Type
- Promise.<any>
deleteById(options, callbackopt) → {Promise.<any>}
Deletes a project.
Parameters:
Name | Type | Attributes | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object | An object containing options to pass to the Jira API. Properties
|
||||||||||
callback |
<optional> |
if supplied, called with result of api call |
- Source:
Returns:
result of api call
- Type
- Promise.<any>
find(options, callbackopt) → {Promise.<any>}
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.the parameters to expandif this parameter is set then only projects recently accessed by the current user (if not logged in then based on HTTP session) will be returned (maximum count limited to the specified number but no more than 20).
Parameters:
Name | Type | Attributes | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object | An object containing options to pass to the Jira API. Properties
|
|||||||||||||
callback |
<optional> |
if supplied, called with result of api call |
- Source:
Returns:
result of api call
- Type
- Promise.<any>
findById(options, callbackopt) → {Promise.<any>}
Contains a full representation of a project in JSON format.
All project keys associated with the project will only be returned if expand=projectKeys. the parameters to expand
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object | An object containing options to pass to the Jira API. Properties
|
|||||||||||||||||
callback |
<optional> |
if supplied, called with result of api call |
- Source:
Returns:
result of api call
- Type
- Promise.<any>
getAllAvatars(options, callbackopt) → {Promise.<any>}
Returns all avatars which are visible for the currently logged in user. The avatars are grouped into system and custom.
Parameters:
Name | Type | Attributes | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object | An object containing options to pass to the Jira API. Properties
|
||||||||||
callback |
<optional> |
if supplied, called with result of api call |
- Source:
Returns:
result of api call
- Type
- Promise.<any>
getAllStatuses(options, callbackopt) → {Promise.<any>}
Get all issue types with valid status values for a project
Parameters:
Name | Type | Attributes | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object | An object containing options to pass to the Jira API. Properties
|
||||||||||
callback |
<optional> |
if supplied, called with result of api call |
- Source:
Returns:
result of api call
- Type
- Promise.<any>
getProjectComponents(options, callbackopt) → {Promise.<any>}
Contains a full representation of a the specified project's components.
Parameters:
Name | Type | Attributes | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object | An object containing options to pass to the Jira API. Properties
|
||||||||||
callback |
<optional> |
if supplied, called with result of api call |
- Source:
Returns:
result of api call
- Type
- Promise.<any>
getProjectVersions(options, callbackopt) → {Promise.<any>}
Contains a full representation of a the specified project's versions.the parameters to expand
Parameters:
Name | Type | Attributes | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object | An object containing options to pass to the Jira API. Properties
|
|||||||||||||
callback |
<optional> |
if supplied, called with result of api call |
- Source:
Returns:
result of api call
- Type
- Promise.<any>
getProjectVersionsPaginated(options, callbackopt) → {Promise.<any>}
Returns all versions for the specified project. Results are paginated.
Results can be ordered by the following fields:
sequence name startDate releaseDate
the page offset, if not specified then defaults to 0how many results on the page should be included. Defaults to 50.ordering of the results.the parameters to expand
Parameters:
Name | Type | Attributes | Description | |||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object | An object containing options to pass to the Jira API. Properties
|
||||||||||||||||||||||
callback |
<optional> |
if supplied, called with result of api call |
- Source:
Returns:
result of api call
- Type
- Promise.<any>
storeTemporaryAvatar(options, callbackopt) → {Promise.<any>}
Creates temporary avatarname of file being uploadedsize of file
Parameters:
Name | Type | Attributes | Description | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object | An object containing options to pass to the Jira API. Properties
|
||||||||||||||||
callback |
<optional> |
if supplied, called with result of api call |
- Source:
Returns:
result of api call
- Type
- Promise.<any>
storeTemporaryAvatarUsingMultiPart(options, callbackopt) → {Promise.<any>}
Creates temporary avatar using multipart. The response is sent back as JSON stored in a textarea. This is because the client uses remote iframing to submit avatars using multipart. So we must send them a valid HTML page back from which the client parses the JSON.
Parameters:
Name | Type | Attributes | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object | An object containing options to pass to the Jira API. Properties
|
||||||||||
callback |
<optional> |
if supplied, called with result of api call |
- Source:
Returns:
result of api call
- Type
- Promise.<any>
update(options, callbackopt) → {Promise.<any>}
Updates a project.
Only non null values sent in JSON will be updated in the project. Values available for the assigneeType field are: "PROJECT_LEAD" and "UNASSIGNED".the parameters to expand in returned project
Parameters:
Name | Type | Attributes | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object | An object containing options to pass to the Jira API. Properties
|
|||||||||||||
callback |
<optional> |
if supplied, called with result of api call |
- Source:
Returns:
result of api call
- Type
- Promise.<any>
updateProjectAvatar(options, callbackopt) → {Promise.<any>}
Parameters:
Name | Type | Attributes | Description | ||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object | An object containing options to pass to the Jira API. Properties
|
|||||||||||||||||||||||||||||||
callback |
<optional> |
if supplied, called with result of api call |
- Source:
Returns:
result of api call
- Type
- Promise.<any>
updateProjectType(options, callbackopt) → {Promise.<any>}
Updates the type of a project.
Parameters:
Name | Type | Attributes | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
options |
Object | An object containing options to pass to the Jira API. Properties
|
|||||||||||||
callback |
<optional> |
if supplied, called with result of api call |
- Source:
Returns:
result of api call
- Type
- Promise.<any>