synergia-jira-connector

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>JSDoc: Source: api/comment.js</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">Source: api/comment.js</h1> <section> <article> <pre class="prettyprint source linenums"><code>"use strict"; var errorStrings = require('./../lib/error'); module.exports = CommentClient; /** * Used to access Jira REST endpoints in '/rest/api/2/comment' * @constructor CommentClient * @param {JiraClient} jiraClient */ function CommentClient(jiraClient) { this.jiraClient = jiraClient; /** * Returns the keys of all properties for the comment identified by the key or by the id. * * @method getCommentPropertyKeys * @memberOf CommentClient# * @param opts The options passed in the request to the API. * @param opts.commentId The id of the comment from which keys will be returned. * @param callback Called when the keys have been retrieved. */ this.getCommentPropertyKeys = function (opts, callback) { var options = this.buildRequestOptions(opts, '', 'GET'); this.jiraClient.makeRequest(options, callback); }; /** * Sets the value of the specified comment's property. * * You can use this resource to store a custom data against the comment identified by the key or by the id. The * user who stores the data is required to have permissions to administer the comment. * * @method setCommentProperty * @memberOf CommentClient# * @param opts The options passed in the request to the API. * @param opts.commentId The id of the comment from which keys will be returned. * @param opts.propertyKey The key of the property to be edited. * @param opts.propertyValue The new value of the property. * @param callback Called when the property has been edited. */ this.setCommentProperty = function (opts, callback) { if (!opts.propertyKey) { throw new Error(errorStrings.NO_COMMENT_PROPERTY_KEY_ERROR); } else if (!opts.propertyValue) { throw new Error(errorStrings.NO_COMMENT_PROPERTY_VALUE_ERROR); } var options = this.buildRequestOptions(opts, '/' + opts.propertyKey, 'PUT', opts.propertyValue); this.jiraClient.makeRequest(options, callback, 'Property Edited'); }; /** * Returns the value of the property with a given key from the comment identified by the key or by the id. The user * who retrieves the property is required to have permissions to read the comment. * * @method getCommentProperty * @memberOf CommentClient# * @param opts The options passed in the request to the API. * @param opts.commentId The id of the comment from which keys will be returned. * @param opts.propertyKey The key of the property to be edited. * @param callback Called when the property has been retrieved. */ this.getCommentProperty = function (opts, callback) { if (!opts.propertyKey) { throw new Error(errorStrings.NO_COMMENT_PROPERTY_KEY_ERROR); } var options = this.buildRequestOptions(opts, '/' + opts.propertyKey, 'GET'); this.jiraClient.makeRequest(options, callback); }; /** * Removes the property from the comment identified by the key or by the id. Ths user removing the property is * required to have permissions to administer the comment. * * @method deleteCommentProperty * @memberOf CommentClient# * @param opts The options passed in the request to the API. * @param opts.commentId The id of the comment from which keys will be returned. * @param opts.propertyKey The key of the property to be edited. * @param callback Called when the property has been retrieved. */ this.deleteCommentProperty = function (opts, callback) { if (!opts.propertyKey) { throw new Error(errorStrings.NO_COMMENT_PROPERTY_KEY_ERROR); } var options = this.buildRequestOptions(opts, '/' + opts.propertyKey, 'DELETE'); this.jiraClient.makeRequest(options, callback, 'Comment property deleted'); }; /** * Build out the request options necessary to make a particular API call. * * @private * @method buildRequestOptions * @memberOf CommentClient# * @param {Object} opts The arguments passed to the method. * @param {string} path The path of the endpoint following /issue/{idOrKey} * @param {string} method The request method. * @param {Object} [body] The request body, if any. * @param {Object} [qs] The querystring, if any. opts.expand and opts.fields arrays will be automagically added. * @returns {{uri: string, method: string, body: Object, qs: Object, followAllRedirects: boolean, json: boolean}} */ this.buildRequestOptions = function (opts, path, method, body, qs) { if (!opts.commentId) { throw new Error(errorStrings.NO_COMMENT_ID); } var basePath = '/comment/' + opts.commentId + "/properties"; if (!qs) qs = {}; if (!body) body = {}; if (opts.fields) { qs.fields = ''; opts.fields.forEach(function (field) { qs.fields += field + ',' }); } if (opts.expand) { qs.expand = ''; opts.expand.forEach(function (ex) { qs.expand += ex + ',' }); } return { uri: this.jiraClient.buildURL(basePath + path), method: method, body: body, qs: qs, followAllRedirects: true, json: true }; } }</code></pre> </article> </section> </div> <nav> <h2><a href="index.html">Home</a></h2> <h3>Classes</h3> <ul> <li><a href="ApplicationPropertiesClient.html">ApplicationPropertiesClient</a></li> <li><a href="AttachmentClient.html">AttachmentClient</a></li> <li><a href="AuditingClient.html">AuditingClient</a></li> <li><a href="AvatarClient.html">AvatarClient</a></li> <li><a href="CommentClient.html">CommentClient</a></li> <li><a href="ComponentClient.html">ComponentClient</a></li> <li><a href="CustomFieldOptionClient.html">CustomFieldOptionClient</a></li> <li><a href="DashboardClient.html">DashboardClient</a></li> <li><a href="FieldClient.html">FieldClient</a></li> <li><a href="FilterClient.html">FilterClient</a></li> <li><a href="GroupClient.html">GroupClient</a></li> <li><a href="GroupsClient.html">GroupsClient</a></li> <li><a href="GroupUserPickerClient.html">GroupUserPickerClient</a></li> <li><a href="IssueClient.html">IssueClient</a></li> <li><a href="IssueLinkClient.html">IssueLinkClient</a></li> <li><a href="IssueLinkTypeClient.html">IssueLinkTypeClient</a></li> <li><a href="IssueTypeClient.html">IssueTypeClient</a></li> <li><a href="JiraClient.html">JiraClient</a></li> <li><a href="JqlClient.html">JqlClient</a></li> <li><a href="LicenseRoleClient.html">LicenseRoleClient</a></li> <li><a href="LicenseValidatorClient.html">LicenseValidatorClient</a></li> <li><a href="MyPermissionsClient.html">MyPermissionsClient</a></li> <li><a href="MyPreferencesClient.html">MyPreferencesClient</a></li> <li><a href="MyselfClient.html">MyselfClient</a></li> <li><a href="PasswordClient.html">PasswordClient</a></li> <li><a href="PriorityClient.html">PriorityClient</a></li> <li><a href="ProjectClient.html">ProjectClient</a></li> <li><a href="ProjectValidateClient.html">ProjectValidateClient</a></li> <li><a href="ReindexClient.html">ReindexClient</a></li> <li><a href="ResolutionClient.html">ResolutionClient</a></li> <li><a href="ScreensClient.html">ScreensClient</a></li> <li><a href="SearchClient.html">SearchClient</a></li> <li><a href="SecurityLevelClient.html">SecurityLevelClient</a></li> <li><a href="ServerInfoClient.html">ServerInfoClient</a></li> <li><a href="SettingsClient.html">SettingsClient</a></li> <li><a href="StatusCategoryClient.html">StatusCategoryClient</a></li> <li><a href="StatusClient.html">StatusClient</a></li> <li><a href="UserClient.html">UserClient</a></li> <li><a href="VersionClient.html">VersionClient</a></li> <li><a href="WorkflowClient.html">WorkflowClient</a></li> <li><a href="WorkflowSchemeClient.html">WorkflowSchemeClient</a></li> </ul> <h3>Namespaces</h3> <ul> <li><a href="OauthUtil.html">OauthUtil</a></li> </ul> </nav> <br class="clear"> <footer> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha13</a> on Tue Sep 22 2015 13:08:43 GMT-0500 (CDT) </footer> <script> prettyPrint(); </script> <script src="scripts/linenumber.js"></script> </body> </html>