Antville 1.2-beta API Reference
Class Index | File Index

Classes


Class Membership


Extends HopObject.

Defined in: Membership.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Membership(user, role)
Field Summary
Field Attributes Field Name and Description
<static>  
Membership.created
<static>  
Membership.creator
<static>  
Membership.files
<static>  
Membership.images
<static>  
Membership.modified
<static>  
Membership.modifier
<static>  
Membership.name
<static>  
Membership.polls
<static>  
Membership.role
<static>  
Membership.site
<static>  
Membership.stories
Method Summary
Method Attributes Method Name and Description
 
email_macro(param)
<static>  
Membership.getByName(name)
 
 
 
getPermission(action)
<static>  
Membership.getRoles()
 
link_filter(value, param)
 
notify(action, recipient, subject)
<static>  
Membership.remove(membership)
 
require(role)
<static>  
Membership.require(role)
 
 
 
update(data)
 
Methods borrowed from class HopObject:
addTag, checkbox_macro, created_macro, creator_macro, getFormValue, getTags, getTitle, handleMetadata, input_macro, kind_macro, link_macro, log, macro_macro, map, modified_macro, modifier_macro, onRequest, radiobutton_macro, removeTag, select_macro, self_macro, setTags, skin_macro, textarea_macro, touch, type_macro, upload_macro
Class Detail
Membership(user, role)
Parameters:
{Object} user
{Object} role
Field Detail
<static> {Date} Membership.created

<static> {User} Membership.creator

<static> {File[]} Membership.files

<static> {Image[]} Membership.images

<static> {Date} Membership.modified

<static> {User} Membership.modifier

<static> {String} Membership.name

<static> {Poll[]} Membership.polls

<static> {String} Membership.role

<static> {Site} Membership.site

<static> {Story[]} Membership.stories
Method Detail
email_macro(param)
Parameters:
{Object} param
Throws:
{Error}

<static> {Membership} Membership.getByName(name)
Parameters:
{String} name
Returns:
{Membership}

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

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

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

<static> {String[]} Membership.getRoles()
Returns:
{String[]}
See:
defineConstants

{String} link_filter(value, param)
Parameters:
{Object} value
{Object} param
Returns:
{String}
See:
HopObject#link_filter

notify(action, recipient, subject)
Parameters:
{String} action
{String} recipient
{String} subject

<static> Membership.remove(membership)
Parameters:
{Membership} membership

{Boolean} require(role)
Parameters:
{String} role
Returns:
{Boolean}

<static> {Boolean} Membership.require(role)
Parameters:
{String} role
Returns:
{Boolean}

status_macro()

{String} toString()
Returns:
{String}

update(data)
Parameters:
{Object} data

valueOf()
See:
#toString

Documentation generated by JsDoc Toolkit 2.3.2 on Mon Nov 02 2009 15:35:32 GMT+0100 (CET)