Class Index

Classes


Class opensocial.DataResponse

This object contains the requested server data mapped to the requested keys.

See also: DataRequest


Defined in: opensocial.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Method Summary
Method Attributes Method Name and Description
 
get(key)
Gets the ResponseItem for the requested field.
 
If the entire request had a batch level error, returns the error message.
 
Returns true if there was an error in fetching this data from the server.
Class Detail
opensocial.DataResponse()
Method Detail
{opensocial.ResponseItem} get(key)
Gets the ResponseItem for the requested field.
Parameters:
key
Returns:
{opensocial.ResponseItem} The requested response calculated by the server

{String} getErrorMessage()
If the entire request had a batch level error, returns the error message.
Returns:
{String} A human-readable description of the error that occurred.

{Boolean} hadError()
Returns true if there was an error in fetching this data from the server.
Returns:
{Boolean} True if there was an error; otherwise, false

Documentation generated by JsDoc Toolkit 2.0.2 on Wed Nov 12 2008 12:32:43 GMT-0800 (PST)