Class Index

Classes


Class opensocial.ResponseItem

Represents a response that was generated by processing a data request item on the server.
Defined in: opensocial.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Method Summary
Method Attributes Method Name and Description
 
Gets the response data.
 
If the request had an error, returns the error code.
 
If the request had an error, returns the error message.
 
Returns the original data request.
 
Returns true if there was an error in fetching this data from the server.
Class Detail
opensocial.ResponseItem()
Method Detail
{Object} getData()
Gets the response data.
Returns:
{Object} The requested value calculated by the server; the type of this value is defined by the type of request that was made

{String} getErrorCode()
If the request had an error, returns the error code. The error code can be container-specific or one of the values defined by Error.
Returns:
{String} The error code, or null if no error occurred

{String} getErrorMessage()
If the request had an error, returns the error message.
Returns:
{String} A human-readable description of the error that occurred; can be null, even if an error occurred

{opensocial.DataRequest} getOriginalDataRequest()
Returns the original data request.
Returns:
{opensocial.DataRequest} The data request used to fetch this data response

{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:44 GMT-0800 (PST)