API Docs for: 0.1
Show:

File: /home/alex/dev/work/webapps/branches/scopes/doc/src/bindings/src/result.js

/**
 * 
 * The attributes of a result returned by a Scope
 * 
 * The Result API provides convenience methods for some typical attributes (title, art), but scopes are free to add and use any custom attributes with set/get methods. The only required attribute is 'uri' and it must not be empty before calling Reply.push().
 *
 * @module ScopeJS
 * @class Result
 */
function Result(){}

Result.prototype = {
/**
* Check if this Result instance has a stored result
 * @method has_stored_result
 * @return {Boolean}
*/
has_stored_result: function() {
},
/**
* Get a stored result
 * @method retrieve
 * @return {Result}
*/
retrieve: function() {
},
/**
* Set the "uri" attribute of this result.
 * @method set_uri
 * @param uri {String}
*/
set_uri: function(uri) {
},
/**
* Set the "title" attribute of this result.
 * @method set_title
 * @param title {String}
*/
set_title: function(title) {
},
/**
* Set the "art" attribute of this result.
 * @method set_art
 * @param art {String}
*/
set_art: function(art) {
},
/**
* Set the "dnd_uri" attribute of this result.
 * @method set_dnd_uri
 * @param dnd_uri {String}
*/
set_dnd_uri: function(dnd_uri) {
},
/**
* Indicates to the receiver that this scope should intercept activation requests for this result
 * @method set_intercept_activation
*/
set_intercept_activation: function() {
},
/**
* Check if this result should be activated directly by the shell because the scope doesn't handle activation of this result
 * @method direct_activation
 * @return {Boolean}
*/
direct_activation: function() {
},
/**
* Get the "uri" property of this Result
 * @method uri
 * @return {String}
*/
uri: function() {
},
/**
* Get the "title" property of this Result
 * @method title
 * @return {String}
*/
title: function() {
},
/**
* Get the "art" property of this Result
 * @method art
 * @return {String}
*/
art: function() {
},
/**
* Get the "dnd_uri" property of this Result
 * @method dnd_uri
 * @return {String}
*/
dnd_uri: function() {
},
/**
* Check if this Result has an attribute
 * @method contains
 * @return {Boolean}
*/
contains: function() {
},
/**
* Get the value of an attribute
 * @method value
 * @param value {String}
 * @return {Dictonary}
*/
value: function(value) {
},
/**
* Set the value of an attribute
 * @method set
 * @param key {String}
 * @param value {String}
*/
set: function(key, value) {
},
/**
* Get the value of an attribute
 * @method get
 * @param key {String}
 * @return {String}, {Number} or {Object}
*/
get: function(key) {
}
};