digitalocean
Version:
nodejs wrapper for digitalocean v2 api
204 lines (168 loc) • 7.49 kB
HTML
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Source: digitalocean/image.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/image.js</h1>
<section>
<article>
<pre class="prettyprint source linenums"><code>(function() {
var slice = [].slice,
util = require('./util');
/**
* Image resource
* @class Image
*/
var Image = (function() {
function Image(client) {
this.client = client;
}
/**
* List image 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 Image
*/
Image.prototype.list = function() {
var args = util.extractListArguments(arguments, 0);
return this.client.get.apply(this.client, ['/images', {}].concat(slice.call(args.params), [200, 'images', args.callback]));
};
/**
* Get the identified image object.
*
* @param {number} id - The id of the image to retrieve
* @param {requestCallback} [callback] - callback that handles the response
* @memberof Image
*/
Image.prototype.get = function(id, callback) {
var url = util.safeUrl('images', id);
return this.client.get(url, {}, 200, 'image', callback);
};
/**
* Update the identified image object.
*
* @param {number} id - The id of the image to update
* @param {object} attributes - The attributes with which to create the Droplet. See the {@link https://developers.digitalocean.com/documentation/v2/#images|official docs} for valid attributes.
* @param {requestCallback} [callback] - callback that handles the response
* @memberof Image
*/
Image.prototype.update = function(id, attributes, callback) {
var url = util.safeUrl('images', id);
return this.client.put(url, attributes, 200, 'image', callback);
};
/**
* Delete the identified image object.
*
* @param {number} id - The id of the image to delete
* @param {requestCallback} [callback] - callback that handles the response
* @memberof Image
*/
Image.prototype.delete = function(id, callback) {
var url = util.safeUrl('images', id);
return this.client.delete(url, {}, 204, [], callback);
};
/**
* List of action objects.
*
* @param {number} id - ID of Droplet for which to retrieve actions
* @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 Image
*/
Image.prototype.listActions = function() {
var args = util.extractListArguments(arguments, 1);
var url = util.safeUrl('images', args.identifier, 'actions');
return this.client.get.apply(this.client, [url, {}].concat(slice.call(args.params), [200, 'actions', args.callback]));
};
/**
* Get the identified action object.
*
* @param {number} imageId - The id of the image for which to retrieve the action
* @param {number} id - The id of the action to retrieve
* @param {requestCallback} [callback] - callback that handles the response
* @memberof Image
*/
Image.prototype.getAction = function(imageId, id, callback) {
var url = util.safeUrl('images', imageId, 'actions', id);
return this.client.get(url, {}, 200, 'action', callback);
};
/**
* Create an action on the identified image.
*
* @param {number} imageId - The id of the image for which to create the action
* @param {string|object} parametersOrType - The name of the action to create or an object with key value pairs of parameters.
* @param {requestCallback} [callback] - callback that handles the response
* @memberof Image
*/
Image.prototype.action = function(imageId, parametersOrType, callback) {
var parameters;
if(typeof parametersOrType === 'string') {
parameters = { type: parametersOrType };
} else {
parameters = parametersOrType;
}
var url = util.safeUrl('images', imageId, 'actions');
return this.client.post(url, parameters, 201, 'action', callback);
};
/**
* If the image is a backup, wwitch the identified image from a backup to a snapshot.
*
* @param {number} dropletId - The id of the image for which to create the action
* @param {requestCallback} [callback] - callback that handles the response
* @memberof Image
*/
Image.prototype.convert = function(imageId, callback) {
return this.action(imageId, 'convert', callback);
};
/**
* Add the image to an additional region.
*
* @param {number} imageId - The id of the image for which to create the action
* @param {string|object} parametersOrRegionSlug - If a string, the identifier of the region. Otherwise, an object with required keys of `region`. See the {@link https://developers.digitalocean.com/documentation/v2/#transfer-an-image|official docs} for valid attributes.
* @param {requestCallback} [callback] - callback that handles the response
* @memberof Image
*/
Image.prototype.transfer = function(imageId, parametersOrRegionSlug, callback) {
var parameters;
if(typeof parametersOrRegionSlug !== 'object') {
parameters = {
region: parametersOrRegionSlug
};
} else {
parameters = parametersOrRegionSlug;
}
parameters.type = 'transfer';
return this.action(imageId, parameters, callback);
};
return Image;
})();
module.exports = Image;
}).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>