Classes

Class TagContainerAPI


Defined in: abstract-tag-container.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Abstract class that is implemented by tag containers such as PageAPI or TemplateAPI
Method Summary
Method Attributes Method Name and Description
<static>  
TagContainerAPI.folder  (success, error)
Get this content object's parent folder.
<static>  
TagContainerAPI.node  (success, error)
Get this content object's node.
<static>  
TagContainerAPI.tag(id, success, error)
Gets a tag of the specified id, contained in this content object.
<static>  
TagContainerAPI.tags(settings, success, error)
Retrieves a collection of tags from this content object.

Class Detail

TagContainerAPI()

Abstract class that is implemented by tag containers such as PageAPI or TemplateAPI

Method Detail

{FolderAPI} TagContainerAPI.folder (success, error)

Get this content object's parent folder.
Parameters:
{funtion(FolderAPI)=} success
Optional callback to receive a FolderAPI object as the only argument.
{function(GCNError):boolean=} error
Optional custom error handler.
Returns:
{FolderAPI} This object's parent folder.

{NodeAPI} TagContainerAPI.node (success, error)

Get this content object's node.
Parameters:
{funtion(NodeAPI)=} success
Optional callback to receive a NodeAPI object as the only argument.
{function(GCNError):boolean=} error
Optional custom error handler.
Returns:
{NodeAPI} This object's node.

TagContainerAPI.tag(id, success, error)

Gets a tag of the specified id, contained in this content object.
Parameters:
{number} id
Id of tag to retrieve.
{function} success
{function} error
Returns:
TagAPI

TagContainerAPI.tags(settings, success, error)

Retrieves a collection of tags from this content object.
Parameters:
{object|string|number} settings
(Optional)
{function} success
callback
{function} error
(Optional)
Returns:
TagContainerAPI

Documentation generated by JsDoc Toolkit 2.3.2 on Wed Nov 20 2024 12:29:35 GMT-0000 (UTC)