digitalocean
Version:
nodejs wrapper for digitalocean v2 api
153 lines (124 loc) • 5.32 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Source: digitalocean/tag.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: digitalocean/tag.js</h1>
<section>
<article>
<pre class="prettyprint source linenums"><code>(function() {
var slice = [].slice,
util = require('./util');
/**
* Tag resource
* @class Tag
*/
var Tag = (function() {
function Tag(client) {
this.client = client;
}
/**
* List tag objects.
*
* @param {(number|object)} [page or queryObject] - page number to retrieve or key value pairs of query parameters
* @param {number} [perPage] - number of result per page to retrieve
* @param {listRequestCallback} [callback] - callback that handles the response
* @memberof Tag
*/
Tag.prototype.list = function() {
var args = util.extractListArguments(arguments, 0);
return this.client.get.apply(this.client, ['/tags', {}].concat(slice.call(args.params), [200, 'tags', args.callback]));
};
/**
* Create a tag object.
*
* @param {object} attributes - The attributes with which to create the tag. See the {@link https://developers.digitalocean.com/documentation/v2/#tags|official docs} for valid attributes.
* @param {requestCallback} [callback] - callback that handles the response
* @memberof Tag
*/
Tag.prototype.create = function(attributes, callback) {
return this.client.post('/tags', attributes, 201, 'tag', callback);
};
/**
* Get the identified tag object.
*
* @param {string} name - The name of the tag to retrieve
* @param {requestCallback} [callback] - callback that handles the response
* @memberof Tag
*/
Tag.prototype.get = function(name, callback) {
var url = util.safeUrl('tags', name);
return this.client.get(url, {}, 200, 'tag', callback);
};
/**
* @typedef Resources
* @type {object}
* @property {string} resource_id - a resource ID.
* @property {string} resource_type - a resource type.
*/
/**
* Associate the identified tag with the identified resources.
*
* @param {string} name - The name of the tag to udpate
* @param {Resources[]} resources - An array of objects each with keys of resource_id and resource_type.
* @param {requestCallback} [callback] - callback that handles the response
* @memberof Tag
*/
Tag.prototype.tag = function(name, resources, callback) {
var attributes = { "resources": resources };
var url = util.safeUrl('tags', name, 'resources');
return this.client.post(url, attributes, 204, [], callback);
};
/**
* Unassociate the identified tag with the identified resources.
*
* @param {string} name - The name of the tag to udpate
* @param {Resources[]} resources - An array of objects each with keys of resource_id and resource_type.
* @param {requestCallback} [callback] - callback that handles the response
* @memberof Tag
*/
Tag.prototype.untag = function(name, resources, callback) {
var attributes = { "resources": resources };
var url = util.safeUrl('tags', name, 'resources');
return this.client.delete(url, attributes, 204, [], callback);
};
/**
* Delete the identified tag object.
*
* @param {string} name - The name of the tag to delete
* @param {requestCallback} [callback] - callback that handles the response
* @memberof Tag
*/
Tag.prototype.delete = function(name, callback) {
var url = util.safeUrl('tags', name);
return this.client.delete(url, {}, 204, [], callback);
};
return Tag;
})();
module.exports = Tag;
}).call(this);
</code></pre>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Account.html">Account</a></li><li><a href="Action.html">Action</a></li><li><a href="Certificate.html">Certificate</a></li><li><a href="Client.html">Client</a></li><li><a href="Domain.html">Domain</a></li><li><a href="Droplet.html">Droplet</a></li><li><a href="Firewall.html">Firewall</a></li><li><a href="FloatingIp.html">FloatingIp</a></li><li><a href="Image.html">Image</a></li><li><a href="ListResponse.html">ListResponse</a></li><li><a href="LoadBalancer.html">LoadBalancer</a></li><li><a href="Region.html">Region</a></li><li><a href="Size.html">Size</a></li><li><a href="Snapshot.html">Snapshot</a></li><li><a href="Tag.html">Tag</a></li><li><a href="Volume.html">Volume</a></li></ul><h3><a href="global.html">Global</a></h3>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a>
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>