synergia-jira-connector

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>JSDoc: Class: IssueClient</title> <script src="scripts/prettify/prettify.js"></script> <script src="scripts/prettify/lang-css.js"></script>  <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css"> <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css"> </head> <body> <div id="main"> <h1 class="page-title">Class: IssueClient</h1> <section> <header> <h2> IssueClient </h2> </header> <article> <div class="container-overview"> <h2>Constructor</h2> <h4 class="name" id="IssueClient"><span class="type-signature"></span>new IssueClient<span class="signature">(jiraClient)</span><span class="type-signature"></span></h4> <div class="description"> <p>Used to access Jira REST endpoints in '/rest/api/2/issue'</p> </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>jiraClient</code></td> <td class="type"> <span class="param-type"><a href="JiraClient.html">JiraClient</a></span> </td> <td class="description last"></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="api_issue.js.html">api/issue.js</a>, <a href="api_issue.js.html#line8">line 8</a> </li> </ul> </dd> </dl> </div> <h3 class="subsection-title">Methods</h3> <h4 class="name" id="addComment"><span class="type-signature"></span>addComment<span class="signature">(opts, callback)</span><span class="type-signature"></span></h4> <div class="description"> <p>Add a comment to an issue</p> </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>opts</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last"><p>The options to pass to the API. Note that this object must contain EITHER an issueId or issueKey property; issueId will be used over issueKey if both are present.</p> <h6>Properties</h6> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>issueId</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>The id of the issue. EX: 10002</p></td> </tr> <tr> <td class="name"><code>issueKey</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>The Key of the issue. EX: JWR-3</p></td> </tr> <tr> <td class="name"><code>comment</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="attributes"> </td> <td class="description last"><p>See <a href="https://docs.atlassian.com/jira/REST/latest/#d2e482">https://docs.atlassian.com/jira/REST/latest/#d2e482</a> </p></td> </tr> </tbody> </table> </td> </tr> <tr> <td class="name"><code>callback</code></td> <td class="type"> </td> <td class="description last"></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="api_issue.js.html">api/issue.js</a>, <a href="api_issue.js.html#line260">line 260</a> </li> </ul> </dd> </dl> <h4 class="name" id="addWatcher"><span class="type-signature"></span>addWatcher<span class="signature">(opts, callback)</span><span class="type-signature"></span></h4> <div class="description"> <p>Adds a user to an issue's watcher list.</p> </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>opts</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last"><p>The options to pass to the API. Note that this object must contain EITHER an issueId or issueKey property; issueId will be used over issueKey if both are present.</p> <h6>Properties</h6> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>issueId</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>The id of the issue. EX: 10002</p></td> </tr> <tr> <td class="name"><code>issueKey</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>The Key of the issue. EX: JWR-3</p></td> </tr> <tr> <td class="name"><code>watcher</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> </td> <td class="description last"><p>The username of the user to add as a watcher.</p></td> </tr> </tbody> </table> </td> </tr> <tr> <td class="name"><code>callback</code></td> <td class="type"> </td> <td class="description last"><p>Called after the watcher is added.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="api_issue.js.html">api/issue.js</a>, <a href="api_issue.js.html#line657">line 657</a> </li> </ul> </dd> </dl> <h4 class="name" id="addWorkLog"><span class="type-signature"></span>addWorkLog<span class="signature">(opts, callback)</span><span class="type-signature"></span></h4> <div class="description"> <p>Adds a new worklog entry to an issue.</p> </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>opts</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last"><p>The options to pass to the API. Note that this object must contain EITHER an issueId or issueKey property; issueId will be used over issueKey if both are present.</p> <h6>Properties</h6> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>issueId</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>The id of the issue. EX: 10002</p></td> </tr> <tr> <td class="name"><code>issueKey</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>The Key of the issue. EX: JWR-3</p></td> </tr> <tr> <td class="name"><code>adjustEstimate</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>Allows you to provide specific instructions to update the remaining time estimate of the issue. Valid values are</p> <pre class="prettyprint source"><code>* "new" - sets the estimate to a specific value * "leave"- leaves the estimate as is * "manual" - specify a specific amount to increase remaining estimate by * "auto"- Default option. Will automatically adjust the value based on the new timeSpent specified on the worklog</code></pre> </td> </tr> <tr> <td class="name"><code>newEstimate</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>(required when "new" is selected for adjustEstimate) the new value for the remaining estimate field. e.g. "2d"</p></td> </tr> <tr> <td class="name"><code>reduceBy</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>(required when "manual" is selected for adjustEstimate) the amount to reduce the remaining estimate by e.g. "2d"</p></td> </tr> <tr> <td class="name"><code>worklog</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="attributes"> </td> <td class="description last"><p>See {@link: https://docs.atlassian.com/jira/REST/latest/#d2e1106}</p></td> </tr> </tbody> </table> </td> </tr> <tr> <td class="name"><code>callback</code></td> <td class="type"> </td> <td class="description last"><p>Called after the worklog is added.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="api_issue.js.html">api/issue.js</a>, <a href="api_issue.js.html#line716">line 716</a> </li> </ul> </dd> </dl> <h4 class="name" id="assignIssue"><span class="type-signature"></span>assignIssue<span class="signature">(opts, callback)</span><span class="type-signature"></span></h4> <div class="description"> <p>Assigns an issue to a user. You can use this resource to assign issues when the user submitting the request has the assign permission but not the edit issue permission. If the name is "-1" automatic assignee is used. A null name will remove the assignee.</p> </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>opts</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last"><p>The options to pass to the API. Note that this object must contain EITHER an issueId or issueKey property; issueId will be used over issueKey if both are present.</p> <h6>Properties</h6> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>issueId</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>The id of the issue. EX: 10002</p></td> </tr> <tr> <td class="name"><code>issueKey</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>The Key of the issue. EX: JWR-3</p></td> </tr> <tr> <td class="name"><code>assignee</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> </td> <td class="description last"><p>The name of the user to whom to assign the issue. -1 for default, null for no assignee.</p></td> </tr> </tbody> </table> </td> </tr> <tr> <td class="name"><code>callback</code></td> <td class="type"> </td> <td class="description last"><p>Called when the issue has been assigned.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="api_issue.js.html">api/issue.js</a>, <a href="api_issue.js.html#line217">line 217</a> </li> </ul> </dd> </dl> <h4 class="name" id="bulkCreate"><span class="type-signature"></span>bulkCreate<span class="signature">(issues, callback)</span><span class="type-signature"></span></h4> <div class="description"> <p>Creates issues or sub-tasks from a JSON representation.</p> <p>Creates many issues in one bulk operation.</p> <p>Creating a sub-task is similar to creating a regular issue. More details can be found in createIssue section: IssueResource#createIssue(IssueUpdateBean)}</p> </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>issues</code></td> <td class="type"> </td> <td class="description last"><p>See <a href="https://docs.atlassian.com/jira/REST/latest/#d2e828">https://docs.atlassian.com/jira/REST/latest/#d2e828</a> </p></td> </tr> <tr> <td class="name"><code>callback</code></td> <td class="type"> </td> <td class="description last"><p>Called when the issues have been created.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="api_issue.js.html">api/issue.js</a>, <a href="api_issue.js.html#line97">line 97</a> </li> </ul> </dd> </dl> <h4 class="name" id="createIssue"><span class="type-signature"></span>createIssue<span class="signature">(issue, callback)</span><span class="type-signature"></span></h4> <div class="description"> <p>Creates an issue or a sub-task from a JSON representation.</p> <p>The fields that can be set on create, in either the fields parameter or the update parameter can be determined using the /rest/api/2/issue/createmeta resource. If a field is not configured to appear on the create screen, then it will not be in the createmeta, and a field validation error will occur if it is submitted.</p> <p>Creating a sub-task is similar to creating a regular issue, with two important differences:</p> <ul> <li>the issueType field must correspond to a sub-task issue type (you can use /issue/createmeta to discover sub-task issue types), and </li> <li>you must provide a parent field in the issue create request containing the id or key of the parent issue. </li> </ul> </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>issue</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last"><p>The issue data in the form of POST body to the JIRA API. See <a href="https://docs.atlassian.com/jira/REST/latest/#d2e398">https://docs.atlassian.com/jira/REST/latest/#d2e398</a> </p></td> </tr> <tr> <td class="name"><code>callback</code></td> <td class="type"> </td> <td class="description last"><p>Called when the issue has been created.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="api_issue.js.html">api/issue.js</a>, <a href="api_issue.js.html#line16">line 16</a> </li> </ul> </dd> </dl> <h4 class="name" id="createRemoteLink"><span class="type-signature"></span>createRemoteLink<span class="signature">(opts, callback)</span><span class="type-signature"></span></h4> <div class="description"> <p>Creates (or updates) a remote issue link from a JSON representation. If a globalId is provided and a remote issue link exists with that globalId, the remote issue link is updated. Otherwise, the remote issue link is created.</p> </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>opts</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last"><p>The options to pass to the API. Note that this object must contain EITHER an issueId or issueKey property; issueId will be used over issueKey if both are present.</p> <h6>Properties</h6> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>issueId</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>The id of the issue. EX: 10002</p></td> </tr> <tr> <td class="name"><code>issueKey</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>The Key of the issue. EX: JWR-3</p></td> </tr> <tr> <td class="name"><code>remoteLink</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="attributes"> </td> <td class="description last"><p>See <a href="https://docs.atlassian.com/jira/REST/latest/#d2e945">https://docs.atlassian.com/jira/REST/latest/#d2e945</a> </p></td> </tr> </tbody> </table> </td> </tr> <tr> <td class="name"><code>callback</code></td> <td class="type"> </td> <td class="description last"><p>Called when the remote links are retrieved.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="api_issue.js.html">api/issue.js</a>, <a href="api_issue.js.html#line408">line 408</a> </li> </ul> </dd> </dl> <h4 class="name" id="deleteComment"><span class="type-signature"></span>deleteComment<span class="signature">(opts, callback)</span><span class="type-signature"></span></h4> <div class="description"> <p>Delete an existing comment.</p> </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>opts</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last"><p>The options to pass to the API. Note that this object must contain EITHER an issueId or issueKey property; issueId will be used over issueKey if both are present.</p> <h6>Properties</h6> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>issueId</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>The id of the issue. EX: 10002</p></td> </tr> <tr> <td class="name"><code>issueKey</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>The Key of the issue. EX: JWR-3</p></td> </tr> <tr> <td class="name"><code>commentId</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> </td> <td class="description last"><p>The id of the comment.</p></td> </tr> </tbody> </table> </td> </tr> <tr> <td class="name"><code>callback</code></td> <td class="type"> </td> <td class="description last"><p>Called when the comment is retrieved.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="api_issue.js.html">api/issue.js</a>, <a href="api_issue.js.html#line323">line 323</a> </li> </ul> </dd> </dl> <h4 class="name" id="deleteIssue"><span class="type-signature"></span>deleteIssue<span class="signature">(opts, callback)</span><span class="type-signature"></span></h4> <div class="description"> <p>Delete an issue. If the issue has subtasks you must set the parameter deleteSubtasks=true to delete the issue. You cannot delete an issue without its subtasks also being deleted.</p> </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>opts</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last"><p>The options to pass to the API. Note that this object must contain EITHER an issueId or issueKey property; issueId will be used over issueKey if both are present.</p> <h6>Properties</h6> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>issueId</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>The id of the issue. EX: 10002</p></td> </tr> <tr> <td class="name"><code>issueKey</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>The Key of the issue. EX: JWR-3</p></td> </tr> <tr> <td class="name"><code>deleteSubTasks</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>"a String of true or false indicating that any subtasks should also be deleted. If the issue has no subtasks this parameter is ignored. If the issue has subtasks and this parameter is missing or false, then the issue will not be deleted and an error will be returned."</p></td> </tr> </tbody> </table> </td> </tr> <tr> <td class="name"><code>callback</code></td> <td class="type"> </td> <td class="description last"></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="api_issue.js.html">api/issue.js</a>, <a href="api_issue.js.html#line165">line 165</a> </li> </ul> </dd> </dl> <h4 class="name" id="deleteRemoteLink"><span class="type-signature"></span>deleteRemoteLink<span class="signature">(opts, callback)</span><span class="type-signature"></span></h4> <div class="description"> <p>Delete the remote issue link with the given global id on the issue.</p> </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>opts</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last"><p>The options to pass to the API. Note that this object must contain EITHER an issueId or issueKey property; issueId will be used over issueKey if both are present.</p> <h6>Properties</h6> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>issueId</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>The id of the issue. EX: 10002</p></td> </tr> <tr> <td class="name"><code>issueKey</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>The Key of the issue. EX: JWR-3</p></td> </tr> <tr> <td class="name"><code>globalId</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> </td> <td class="description last"><p>The global id of the remote issue link</p></td> </tr> </tbody> </table> </td> </tr> <tr> <td class="name"><code>callback</code></td> <td class="type"> </td> <td class="description last"><p>Called when the remote links are retrieved.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="api_issue.js.html">api/issue.js</a>, <a href="api_issue.js.html#line445">line 445</a> </li> </ul> </dd> </dl> <h4 class="name" id="deleteRemoteLinkById"><span class="type-signature"></span>deleteRemoteLinkById<span class="signature">(opts, callback)</span><span class="type-signature"></span></h4> <div class="description"> <p>Get the remote issue link with the given id on the issue.</p> </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>opts</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last"><p>The options to pass to the API. Note that this object must contain EITHER an issueId or issueKey property; issueId will be used over issueKey if both are present.</p> <h6>Properties</h6> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>issueId</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>The id of the issue. EX: 10002</p></td> </tr> <tr> <td class="name"><code>issueKey</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>The Key of the issue. EX: JWR-3</p></td> </tr> <tr> <td class="name"><code>linkId</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> </td> <td class="description last"><p>The id of the remote link</p></td> </tr> </tbody> </table> </td> </tr> <tr> <td class="name"><code>callback</code></td> <td class="type"> </td> <td class="description last"><p>Called when the remote links are retrieved.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"> <ul class="dummy"> <li> <a href="api_issue.js.html">api/issue.js</a>, <a href="api_issue.js.html#line512">line 512</a> </li> </ul> </dd> </dl> <h4 class="name" id="deleteWorkLog"><span class="type-signature"></span>deleteWorkLog<span class="signature">(opts, callback)</span><span class="type-signature"></span></h4> <div class="description"> <p>Deletes an existing worklog entry</p> </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last"