Antville 1.2-beta API Reference
Class Index | File Index

Classes


Class Story


Extends HopObject.

Defined in: Story.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Story()
Field Summary
Field Attributes Field Name and Description
<static>  
Story._children
<static>  
Story.commentMode
<static>  
Story.comments
<static>  
Story.created
<static>  
Story.creator
<static>  
Story.metadata
<static>  
Story.mode
<static>  
Story.modified
<static>  
Story.modifier
<static>  
Story.name
<static>  
Story.parent_id
<static>  
Story.parent_type
<static>  
Story.prototype
<static>  
Story.requests
<static>  
Story.site
<static>  
Story.status
<static>  
Story.tags
<static>  
Story.text
<static>  
Story.title
Method Summary
Method Attributes Method Name and Description
 
comments_macro(param, mode)
 
Increment the request counter
 
format_filter(value, param, mode)
<static>  
 
getDelta(data)
Calculate the difference of a story’s current and its updated content
 
 
 
<static>  
Story.getModes()
 
getPermission(action)
<static>  
Story.getStatus()
 
getTitle(limit)
 
isMetadata(name)
 
link_macro(param, action, text)
 
macro_filter(value, param)
 
referrers_macro(param, limit)
<static>  
Story.remove()
 
 
 
tags_macro(param, mode)
 
update(data)
 
url_filter(value, param, mode)
Methods borrowed from class HopObject:
addTag, checkbox_macro, created_macro, creator_macro, getTags, handleMetadata, input_macro, kind_macro, link_filter, log, macro_macro, map, modified_macro, modifier_macro, notify, onRequest, radiobutton_macro, removeTag, select_macro, self_macro, setTags, skin_macro, textarea_macro, toString, touch, type_macro, upload_macro
Class Detail
Story()
Field Detail
<static> {Comment[]} Story._children

<static> {String} Story.commentMode

<static> {Comment[]} Story.comments

<static> {Date} Story.created

<static> {User} Story.creator

<static> {Metadata} Story.metadata

<static> {String} Story.mode

<static> {Date} Story.modified

<static> {User} Story.modifier

<static> {String} Story.name

<static> {Number} Story.parent_id

<static> {String} Story.parent_type

<static> {String} Story.prototype

<static> {Number} Story.requests

<static> {Site} Story.site

<static> {String} Story.status

<static> {TagHub[]} Story.tags

<static> {String} Story.text

<static> {String} Story.title
Method Detail
comments_macro(param, mode)
Parameters:
{Object} param
{String} mode

count()
Increment the request counter

{String} format_filter(value, param, mode)
Parameters:
{Object} value
{Object} param
{String} mode
Returns:
{String}

<static> {String[]} Story.getCommentModes()
Returns:
{String[]}
See:
defineConstants

{Number} getDelta(data)
Calculate the difference of a story’s current and its updated content
Parameters:
{Object} data
Returns:
{Number}

{String[]} getFormOptions(name)
Parameters:
{String} name
Returns:
{String[]}

{Object} getFormValue(name)
Parameters:
{String} name
Returns:
{Object}

{HopObject} getMacroHandler(name)
Parameters:
{String} name
Returns:
{HopObject}

<static> {String[]} Story.getModes()
Returns:
{String[]}
See:
defineConstants

{Boolean} getPermission(action)
Parameters:
{String} action
Returns:
{Boolean}

<static> {String[]} Story.getStatus()
Returns:
{String[]}
See:
defineConstants

{String} getTitle(limit)
Parameters:
{Number} limit
Returns:
{String}

isMetadata(name)
Parameters:
{String} name

link_macro(param, action, text)
Parameters:
{Object} param
{String} action
{String} text

{String} macro_filter(value, param)
Parameters:
{String|Skin} value
{Object} param
Returns:
{String}

referrers_macro(param, limit)
Parameters:
{Object} param
{Number} limit

<static> Story.remove()

setMetadata(data)
Parameters:
{Object} data

summary_macro(param)
Parameters:
{Object} param

tags_macro(param, mode)
Parameters:
{Object} param
{String} mode

update(data)
Parameters:
{Object} data

{String} url_filter(value, param, mode)
Parameters:
{String} value
{Object} param
{String} mode
Returns:
{String}

Documentation generated by JsDoc Toolkit 2.3.2 on Sat Jan 16 2010 00:41:44 GMT+0100 (CET)