Classes Files

Classes

Documentation generator: JsDoc Toolkit 2.4.0
Template: Codeview 1.2
Generated on: 2011-3-3 14:20

Class Tag

Class Summary
Constructor Attributes Constructor Name and Description
 
Tag()
Field Summary
Field Attributes Field Name and Description
 
id
Read-only The sha1 hash of this Tag.
 
message
The message associated with this Tag.
 
name
The name of this Tag.
 
tagger
The person who created this Tag.
 
targetId
The object this Tag is pointing at.
 
targetType
The type of object this Tag is pointing at.

Method Summary

Method Attributes Method Name and Description
 
save(callback)
Saves the data contained in this Tag and updates the ID.

Class Detail

Tag()
See:
Repository#getTag
Repository#createTag

Field Detail

{String} id
Read-only The sha1 hash of this Tag.
{String} message
The message associated with this Tag.
{String} name
The name of this Tag.
{Signature} tagger
The person who created this Tag.
{String} targetId
The object this Tag is pointing at.
{String} targetType
The type of object this Tag is pointing at.

Method Detail

  • {Boolean} save(callback)
    Saves the data contained in this Tag and updates the ID.
    Parameters:
    {Function} callback Optional
    If provided, the Tag will be saved asynchronously and the results provided to the callback.
    Throws:
    If an error occurs during save process.
    Returns:
    {Boolean} true if successful.