Class TemplateAPI
Extends
ContentObjectAPI, TagContainerAPI.
Defined in: template.js.
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
TemplateAPI(id, success, error, settings)
WARNING! Currently the template API is still in
development and has no specific implementation.
|
| Method Attributes | Method Name and Description |
|---|---|
| <static> |
TemplateAPI.createTag(construct, magicValue, success, error)
Creates a tag of a given tagtype in this template.
|
| <static> |
TemplateAPI.folder(success, error)
Not yet implemented.
|
| <static> |
TemplateAPI.remove(success, error)
Not yet implemented.
|
| <static> |
TemplateAPI.removeTag()
|
| <static> |
TemplateAPI.removeTags()
|
| <static> |
TemplateAPI.save(success, error)
Not yet implemented.
|
Class Detail
TemplateAPI(id, success, error, settings)
WARNING! Currently the template API is still in
development and has no specific implementation. Do not use the
TemplateAPI as it is subject to change.
- Parameters:
- {number|string} id
- of the template to be loaded
- {function(ContentObjectAPI))=} success
- Optional success callback that will receive this object as its only argument.
- {function(GCNError):boolean=} error
- Optional custom error handler.
- {object} settings
- currently there are no additional settings to be used
Method Detail
{TagAPI} TemplateAPI.createTag(construct, magicValue, success, error)
Creates a tag of a given tagtype in this template.
Exmaple:
createTag('link', 'http://www.gentics.com', onSuccess, onError);
or
createTag('link', onSuccess, onError);
- Parameters:
- {string} construct
- The name of the construct on which the tag to be created should be derived from.
- {string=} magicValue
- Optional property that will override the default values of this tag type.
- {function(TagAPI)=} success
- Optional callback that will receive the newly created tag as its only argument.
- {function(GCNError):boolean=} error
- Optional custom error handler.
- Throws:
- INVALID_ARGUMENTS
- Returns:
- {TagAPI} The newly created tag.
TemplateAPI.folder(success, error)
Not yet implemented.
- Parameters:
- success
- error
TemplateAPI.remove(success, error)
Not yet implemented.
- Parameters:
- success
- error
TemplateAPI.removeTag()
TemplateAPI.removeTags()
TemplateAPI.save(success, error)
Not yet implemented.
- Parameters:
- success
- error