Class Membership
Extends
HopObject.
Defined in: Membership.js.
Constructor Attributes | Constructor Name and Description |
---|---|
Membership(user, role)
|
Field Attributes | Field Name and Description |
---|---|
Method Attributes | Method Name and Description |
---|---|
email_macro(param)
|
|
<static> |
Membership.getByName(name, site)
|
getFormOptions(name)
|
|
getMacroHandler(name)
|
|
getPermission(action)
|
|
<static> |
Membership.getRoles()
|
link_filter(value, param)
|
|
notify(action, recipient, subject)
|
|
<static> |
Membership.remove(membership, options)
|
require(role)
|
|
<static> |
Membership.require(role)
|
toString()
|
|
update(data)
|
|
valueOf()
|
- 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
Field Detail
{Comment[]}
comments
{Story[]}
content
{Date}
created
{User}
creator
{File[]}
files
{Image[]}
images
{Date}
modified
{User}
modifier
{String}
name
{Poll[]}
polls
{String}
role
{Site}
site
{Story[]}
stories
Method Detail
email_macro(param)
- Parameters:
- {Object} param
- Throws:
- {Error}
<static>
{Membership}
Membership.getByName(name, site)
- Parameters:
- {String} name
- {Site} site
- Returns:
- {Membership}
{String}
getConfirmText()
- Returns:
- {String}
{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}
notify(action, recipient, subject)
- Parameters:
- {String} action
- {String} recipient
- {String} subject
<static>
Membership.remove(membership, options)
- Parameters:
- {Membership} membership
- {Object} options
{Boolean}
require(role)
- Parameters:
- {String} role
- Returns:
- {Boolean}
<static>
{Boolean}
Membership.require(role)
- Parameters:
- {String} role
- Returns:
- {Boolean}
role_macro()
status_macro()
{String}
toString()
- Returns:
- {String}
update(data)
- Parameters:
- {Object} data
valueOf()
- See:
- #toString