API Documentation¶

User¶

User.login(String username, String password)
returns: boolean
callback: User.loadSession() on success

User.logout(void)
returns: boolean
callback: User.unloadSession() on success

User.changePassword(String oldPassword, String newPassword, String confirmNewPassword)
returns: boolean
callback: User.reloadSession() on success

Search¶

Search.query(object parameters)
returns: object[] derivative

Search.getSavedSearches(void)
returns: object[] savedSearch

Search.loadSearch(String savedSearch._id)
returns: object[] derivative

Search.saveSearch(object parameters, String alias)
returns: boolean

Media¶

Media.getAll(void)
returns: object[] mediaShortDescription

Media.load(String mediaShortDescription._id)
returns: object derivative

Media.annotate(String mediaShortDescription._id, int timeIn, int timeOut, String content, String user._id, long timestamp)
returns: boolean

Media.sendMessage(String medaShortDescription._id, long timestamp, String user._id, String content)
returns: boolean

Source¶

Source.view(String source._id)
returns: object source

Source.addDetail(String source._id, String key, object value)
returns: boolean