Opensocial.DataResponse (v0.9)

Owned by Mark Halvorson (Deactivated)
Last updated: Oct 05, 2010Version comment

<?xml version="1.0" encoding="utf-8"?>
<html>

NeedsExamples

<div style="float:right; margin: 0 0 10px 10px;">

</div>
<span style="font-size:150%"><strong>opensocial.DataResponse</strong></span>

This object contains the requested server data mapped to the requested keys. See also: DataRequest

Methods

opensocial.DataResponse.get

;<code style="color:green"> opensocial.ResponseItem get(key)</code>

<strong>Parameters</strong>
<table cellspacing="0" cellpadding="4" border="1"> <tr><th>Name</th> <th>Type</th> <th>Description</th></tr> <tr><td>key</td> <c/> <c/> </table>

<strong>Returns</strong>
<table cellspacing="0" cellpadding="4" border="1"> <tr><th>Type</th> <th>Description</th></tr> <tr><td>opensocial.ResponseItem </td> <td>The requested response calculated by the server</td></tr> </table>

Description
<div style="margin-left:4em;">Gets the ResponseItem for the requested field.</div>

opensocial.DataResponse.getErrorMessage

;<code style="color:green">String getErrorMessage()</code>

<strong>Returns</strong>
<table cellspacing="0" cellpadding="4" border="1"> <tr><th>Type</th> <th>Description</th></tr> <tr><td>String</td> <td>A human-readable description of the error that occurred.</td></tr> </table>

Description
<div style="margin-left:4em;">If the entire request had a batch level error, returns the error message.</div>

opensocial.DataResponse.hadError

;<code style="color:green">Boolean hadError()</code>

<strong>Returns</strong>
<table cellspacing="0" cellpadding="4" border="1"> <tr><th>Type</th> <th>Description</th></tr> <tr><td>Boolean</td> <td>True if there was an error; otherwise, false</td></tr> </table>

Description
<div style="margin-left:4em;">Returns true if there was an error in fetching this data from the server.</div>

{{ JsApiAlphaList_(v0.9) }}

</html>