Class Api
Extends
HopObject.
Defined in: Api.js.
Constructor Attributes | Constructor Name and Description |
---|---|
Api()
|
Method Attributes | Method Name and Description |
---|---|
<static> |
Api.constrain(site, user)
|
<static> |
Api.getSite(name)
|
<static> |
Api.getStory(id)
|
<static> |
Api.getUser(name, password)
|
main_action_xmlrpc(methodName)
|
- Methods borrowed from class HopObject:
- addTag, checkbox_macro, created_macro, creator_macro, getFormOptions, 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, touch, type_macro, upload_macro
Method Detail
<static>
Api.constrain(site, user)
{Boolean}
getPermission()
- Returns:
- {Boolean}
<static>
{Site}
Api.getSite(name)
- Parameters:
- {String} name
- Throws:
- {Error}
- Returns:
- {Site}
<static>
{Story}
Api.getStory(id)
- Parameters:
- {Number} id
- Throws:
- {Error}
- Returns:
- {Story}
<static>
{User}
Api.getUser(name, password)
- Parameters:
- {String} name
- {String} password
- Throws:
- {Error}
- Returns:
- {User}
main_action_xmlrpc(methodName)
- Parameters:
- {String} methodName
- Throws:
- {Error}