synergia-jira-connector
Version:
Easy to use NodeJS wrapper for the Jira REST API.
166 lines (147 loc) • 6.75 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Source: api/dashboard.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/dashboard.js</h1>
<section>
<article>
<pre class="prettyprint source linenums"><code>"use strict";
module.exports = DashboardClient;
/**
* Used to access Jira REST endpoints in '/rest/api/2/dashboard'
* @param {JiraClient} jiraClient
* @constructor DashboardClient
*/
function DashboardClient(jiraClient) {
this.jiraClient = jiraClient;
/**
* Get a list of all dashboards, optionally filtering them.
*
* @method getAllDashboards
* @memberOf DashboardClient#
* @param opts The request options to send to the Jira API
* @param [opts.filter] An optional filter that is applied to the list of dashboards. Valid values include
* "favourite" for returning only favourite dashboards, and "my" for returning dashboards that are owned by the
* calling user.
* @param [opts.startAt] The index of the first dashboard to return (0-based). must be 0 or a multiple of
* maxResults
* @param [opts.maxResults] A hint as to the the maximum number of dashboards to return in each call. Note that the
* JIRA server reserves the right to impose a maxResults limit that is lower than the value that a client
* provides, dues to lack or resources or any other condition. When this happens, your results will be
* truncated. Callers should always check the returned maxResults to determine the value that is effectively
* being used.
* @param callback Called when the dashboards have been retrieved.
*/
this.getAllDashboards = function (opts, callback) {
var options = {
uri: this.jiraClient.buildURL('/dashboard'),
method: 'GET',
json: true,
followAllRedirects: true,
qs: {
filter: opts.filter,
startAt: opts.startAt,
maxResults: opts.maxResults
}
};
this.jiraClient.makeRequest(options, callback);
};
/**
* Get a single dashboard.
*
* @method getDashboard
* @memberOf DashboardClient#
* @param opts The request options sent to the Jira API.
* @param opts.dashboardId The dashboard id.
* @param callback Called when the dashboard has been retrieved
*/
this.getDashboard = function (opts, callback) {
var options = {
uri: this.jiraClient.buildURL('/dashboard/' + opts.dashboardId),
method: 'GET',
json: true,
followAllRedirects: true,
qs: {
filter: opts.filter,
startAt: opts.startAt,
maxResults: opts.maxResults
}
};
this.jiraClient.makeRequest(options, callback);
}
}</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="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 Nov 10 2015
11:10:10 GMT-0600 (CST)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"></script>
</body>
</html>