digitalocean
Version:
nodejs wrapper for digitalocean v2 api
1,522 lines (386 loc) • 20.1 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: Tag</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">Class: Tag</h1>
<section>
<header>
<h2>Tag</h2>
</header>
<article>
<div class="container-overview">
<h4 class="name" id="Tag"><span class="type-signature"></span>new Tag<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Tag resource
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="digitalocean_tag.js.html">digitalocean/tag.js</a>, <a href="digitalocean_tag.js.html#line5">line 5</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="list"><span class="type-signature">(static) </span>Firewall#list<span class="signature">(page or queryObject<span class="signature-attributes">opt</span>, perPage<span class="signature-attributes">opt</span>, callback<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
<div class="description">
List firewall objects.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>page or queryObject</code></td>
<td class="type">
<span class="param-type">number</span>
|
<span class="param-type">object</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">page number to retrieve or key value pairs of query parameters</td>
</tr>
<tr>
<td class="name"><code>perPage</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">number of result per page to retrieve</td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type"><a href="global.html#listRequestCallback">listRequestCallback</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">callback that handles the response</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="digitalocean_firewall.js.html">digitalocean/firewall.js</a>, <a href="digitalocean_firewall.js.html#line22">line 22</a>
</li></ul></dd>
</dl>
<h4 class="name" id="create"><span class="type-signature"></span>create<span class="signature">(attributes, callback<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
<div class="description">
Create a tag object.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>attributes</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="attributes">
</td>
<td class="description last">The attributes with which to create the tag. See the <a href="https://developers.digitalocean.com/documentation/v2/#tags">official docs</a> for valid attributes.</td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type"><a href="global.html#requestCallback">requestCallback</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">callback that handles the response</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="digitalocean_tag.js.html">digitalocean/tag.js</a>, <a href="digitalocean_tag.js.html#line34">line 34</a>
</li></ul></dd>
</dl>
<h4 class="name" id="delete"><span class="type-signature"></span>delete<span class="signature">(name, callback<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
<div class="description">
Delete the identified tag object.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>name</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="description last">The name of the tag to delete</td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type"><a href="global.html#requestCallback">requestCallback</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">callback that handles the response</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="digitalocean_tag.js.html">digitalocean/tag.js</a>, <a href="digitalocean_tag.js.html#line92">line 92</a>
</li></ul></dd>
</dl>
<h4 class="name" id="get"><span class="type-signature"></span>get<span class="signature">(name, callback<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
<div class="description">
Get the identified tag object.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>name</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="description last">The name of the tag to retrieve</td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type"><a href="global.html#requestCallback">requestCallback</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">callback that handles the response</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="digitalocean_tag.js.html">digitalocean/tag.js</a>, <a href="digitalocean_tag.js.html#line45">line 45</a>
</li></ul></dd>
</dl>
<h4 class="name" id="list"><span class="type-signature"></span>list<span class="signature">(page or queryObject<span class="signature-attributes">opt</span>, perPage<span class="signature-attributes">opt</span>, callback<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
<div class="description">
List tag objects.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>page or queryObject</code></td>
<td class="type">
<span class="param-type">number</span>
|
<span class="param-type">object</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">page number to retrieve or key value pairs of query parameters</td>
</tr>
<tr>
<td class="name"><code>perPage</code></td>
<td class="type">
<span class="param-type">number</span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">number of result per page to retrieve</td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type"><a href="global.html#listRequestCallback">listRequestCallback</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">callback that handles the response</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="digitalocean_tag.js.html">digitalocean/tag.js</a>, <a href="digitalocean_tag.js.html#line22">line 22</a>
</li></ul></dd>
</dl>
<h4 class="name" id="tag"><span class="type-signature"></span>tag<span class="signature">(name, resources, callback<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
<div class="description">
Associate the identified tag with the identified resources.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>name</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="description last">The name of the tag to udpate</td>
</tr>
<tr>
<td class="name"><code>resources</code></td>
<td class="type">
<span class="param-type">Array.<<a href="global.html#Resources">Resources</a>></span>
</td>
<td class="attributes">
</td>
<td class="description last">An array of objects each with keys of resource_id and resource_type.</td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type"><a href="global.html#requestCallback">requestCallback</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">callback that handles the response</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="digitalocean_tag.js.html">digitalocean/tag.js</a>, <a href="digitalocean_tag.js.html#line65">line 65</a>
</li></ul></dd>
</dl>
<h4 class="name" id="untag"><span class="type-signature"></span>untag<span class="signature">(name, resources, callback<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4>
<div class="description">
Unassociate the identified tag with the identified resources.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Attributes</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>name</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="attributes">
</td>
<td class="description last">The name of the tag to udpate</td>
</tr>
<tr>
<td class="name"><code>resources</code></td>
<td class="type">
<span class="param-type">Array.<<a href="global.html#Resources">Resources</a>></span>
</td>
<td class="attributes">
</td>
<td class="description last">An array of objects each with keys of resource_id and resource_type.</td>
</tr>
<tr>
<td class="name"><code>callback</code></td>
<td class="type">
<span class="param-type"><a href="global.html#requestCallback">requestCallback</a></span>
</td>
<td class="attributes">
<optional><br>
</td>
<td class="description last">callback that handles the response</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="digitalocean_tag.js.html">digitalocean/tag.js</a>, <a href="digitalocean_tag.js.html#line79">line 79</a>
</li></ul></dd>
</dl>
</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>