Class User
Extends
HopObject, HopObject.
Defined in: User.js.
Constructor Attributes | Constructor Name and Description |
---|---|
User(data)
A User object represents a login to Antville.
|
Field Attributes | Field Name and Description |
---|---|
<static> |
User._children
|
<static> |
User.comments
|
<static> <constant> |
User.COOKIE
|
<static> |
User.created
|
<static> |
User.email
|
<static> |
User.files
|
<static> |
User.hash
|
<static> <constant> |
User.HASHCOOKIE
|
<static> |
User.images
|
<static> |
User.memberships
|
<static> |
User.metadata
|
<static> |
User.modified
|
<static> |
User.name
|
<static> |
User.salt
|
<static> |
User.sites
|
<static> |
User.status
|
<static> |
User.stories
|
<static> |
User.subscriptions
|
Method Attributes | Method Name and Description |
---|---|
<static> |
User.autoLogin()
|
<static> |
User.getByName(name)
|
<static> |
User.getCurrentStatus()
|
getDigest(token)
|
|
getFormOptions(name)
|
|
<static> |
User.getLocation()
|
<static> |
User.getMembership()
|
getPermission(action)
|
|
<static> |
User.getSalt()
|
<static> |
User.getScopes()
|
<static> |
User.getStatus()
|
list_macro(param, type)
|
|
<static> |
User.login(data)
|
<static> |
User.logout()
|
onLogout()
|
|
<static> |
User.register(data)
|
<static> |
User.require(requiredStatus)
|
<static> |
User.setLocation(url)
|
touch()
|
|
update(data)
|
- Methods borrowed from class HopObject:
- addTag, checkbox_macro, created_macro, creator_macro, getFormValue, getTags, getTitle, handleMetadata, input_macro, kind_macro, link_filter, link_macro, log, macro_macro, map, modified_macro, modifier_macro, notify, onRequest, radiobutton_macro, removeTag, select_macro, self_macro, setTags, skin_macro, textarea_macro, toString, type_macro, upload_macro
Field Detail
<static>
{Membership[]}
User._children
<static>
{Comment[]}
User.comments
<static> <constant>
User.COOKIE
<static>
{Date}
User.created
<static>
{String}
User.email
<static>
{File[]}
User.files
<static>
{String}
User.hash
<static> <constant>
User.HASHCOOKIE
<static>
{Image[]}
User.images
<static>
{Membership[]}
User.memberships
<static>
{Metadata}
User.metadata
<static>
{Date}
User.modified
<static>
{String}
User.name
<static>
{String}
User.salt
<static>
{Site[]}
User.sites
<static>
{String}
User.status
<static>
{Story[]}
User.stories
<static>
{Membership[]}
User.subscriptions
Method Detail
<static>
User.autoLogin()
<static>
{User}
User.getByName(name)
- Parameters:
- {String} name
- Returns:
- {User}
<static>
{String}
User.getCurrentStatus()
- Returns:
- {String}
{String}
getDigest(token)
- Parameters:
- {String} token
- Returns:
- {String}
{Object}
getFormOptions(name)
- Parameters:
- {String} name
- Returns:
- {Object}
<static>
{String}
User.getLocation()
- Returns:
- {String}
<static>
{Membership}
User.getMembership()
- Returns:
- {Membership}
{Boolean}
getPermission(action)
- Parameters:
- {String} action
- Returns:
- {Boolean}
<static>
{String}
User.getSalt()
- Returns:
- {String}
<static>
{String[]}
User.getScopes()
- Returns:
- {String[]}
- See:
- defineConstants
<static>
{String[]}
User.getStatus()
- Returns:
- {String[]}
- See:
- defineConstants
list_macro(param, type)
- Parameters:
- {Object} param
- {String} type
<static>
{User}
User.login(data)
- Parameters:
- {Object} data
- Returns:
- {User}
<static>
User.logout()
onLogout()
<static>
{User}
User.register(data)
- Parameters:
- {Object} data
- Throws:
- {Error}
- Returns:
- {User}
<static>
{Boolean}
User.require(requiredStatus)
- Parameters:
- {String} requiredStatus
- Returns:
- {Boolean}
<static>
User.setLocation(url)
- Parameters:
- {String} url
touch()
update(data)
- Parameters:
- {Object} data