synergia-jira-connector
Version:
Easy to use NodeJS wrapper for the Jira REST API.
164 lines (144 loc) • 6.6 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Source: api/application-properties.js</title>
<script src="scripts/prettify/prettify.js"></script>
<script src="scripts/prettify/lang-css.js"></script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<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/application-properties.js</h1>
<section>
<article>
<pre class="prettyprint source linenums"><code>"use strict";
module.exports = ApplicationPropertiesClient;
/**
* Used to access Jira REST endpoints in '/rest/api/2/application-properties'
* @constructor ApplicationPropertiesClient
* @param {JiraClient} jiraClient
*/
function ApplicationPropertiesClient(jiraClient) {
this.jiraClient = jiraClient;
/**
* Gets an application property.
* @method getProperties
* @memberOf ApplicationPropertiesClient#
* @param [opts] The options used to make the request.
* @param [opts.key] A String containing the property key.
* @param [opts.permissionLevel] When fetching a list specifies the permission level of all items in the list.
* @param [opts.keyFilter] When fetching a list allows the list to be filtered by the property's start of key e.g.
* "jira.lf.*" whould fetch only those permissions that are editable and whose keys start with "jira.lf.". This
* is a regex
* @param callback Called when the properties are retrieved.
*/
this.getProperties = function (opts, callback) {
var qs = {};
if (opts) {
if (opts.key) {
qs.key = opts.key;
}
if (opts.keyFilter) {
qs.keyFilter = opts.keyFilter;
}
if (opts.permissionLevel) {
qs.keyFilter = opts.permissionLevel;
}
}
var options = {
uri: this.jiraClient.buildURL('/application-properties'),
method: 'GET',
followAllRedirects: true,
qs: qs
};
this.jiraClient.makeRequest(options, callback);
};
/**
* Modify an application property via PUT. The "value" field present in the PUT will override thee existing value.
*
* @method getProperties
* @memberOf ApplicationPropertiesClient#
* @param opts The options for modifying the application property.
* @param opts.id The id of the property to be modified
* @param opts.property The new data for the property. See
* {@link https://docs.atlassian.com/jira/REST/latest/#d2e4891}
* @param callback Called when the property has been modified
*/
this.setProperty = function (opts, callback) {
var options = {
uri: this.jiraClient.buildURL('/application-properties'),
method: 'GET',
followAllRedirects: true,
body: opts.property
};
this.jiraClient.makeRequest(options, callback, 'Property Updated');
};
}</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="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="ProjectCategoryClient.html">ProjectCategoryClient</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 Oct 27 2015
13:43:13 GMT-0500 (CDT)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"></script>
</body>
</html>