Methods
create(attributes, callbackopt)
Create a tag object.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
attributes |
object | The attributes with which to create the tag. See the official docs for valid attributes. | |
callback |
requestCallback |
<optional> |
callback that handles the response |
- Source:
delete(name, callbackopt)
Delete the identified tag object.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
name |
string | The name of the tag to delete | |
callback |
requestCallback |
<optional> |
callback that handles the response |
- Source:
get(name, callbackopt)
Get the identified tag object.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
name |
string | The name of the tag to retrieve | |
callback |
requestCallback |
<optional> |
callback that handles the response |
- Source:
list(page or queryObjectopt, perPageopt, callbackopt)
List tag objects.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
page or queryObject |
number | object |
<optional> |
page number to retrieve or key value pairs of query parameters |
perPage |
number |
<optional> |
number of result per page to retrieve |
callback |
listRequestCallback |
<optional> |
callback that handles the response |
- Source:
tag(name, resources, callbackopt)
Associate the identified tag with the identified resources.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
name |
string | The name of the tag to udpate | |
resources |
Array.<Resources> | An array of objects each with keys of resource_id and resource_type. | |
callback |
requestCallback |
<optional> |
callback that handles the response |
- Source:
untag(name, resources, callbackopt)
Unassociate the identified tag with the identified resources.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
name |
string | The name of the tag to udpate | |
resources |
Array.<Resources> | An array of objects each with keys of resource_id and resource_type. | |
callback |
requestCallback |
<optional> |
callback that handles the response |
- Source: