new Component()
Component
Properties:
Name | Type | Description |
---|---|---|
connector |
IConnector | the jira connector instance |
- Source:
Methods
create(options, callbackopt) → {Promise.<any>}
Create a component via POST.
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>
delete(options, callbackopt) → {Promise.<any>}
Delete a project component.The new component applied to issues whose 'id' component will be deleted. If this value is null, then the 'id' component is simply removed from the related isues.
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>}
Returns a project component.
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>
getComponentRelatedIssues(options, callbackopt) → {Promise.<any>}
Returns counts of issues related to this component.
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>}
Modify a component via PUT. Any fields present in the PUT will override existing values. As a convenience, if a field is not present, it is silently ignored.
If leadUserName is an empty string ("") the component lead will be removed.
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>