opensocial.ResponseItem
Method
opensocial.ResponseItem.hadError
Boolean hadError()
Returns "True" when an error has occurred and "False" when no error has occurred.
Parameter
None
Return value
| Type | Description |
|---|---|
| Boolean | Whether or not an error has occurred. |
Sample
if (res.hadError()) {
// ...
} else {
// ...
}
opensocial.ResponseItem.getErrorCode
String getErrorCode()
Returns an error code when an error has occurred. The error code contains the value defined in opensocial.ResponseItem.Error.
Parameter
None
Return value
| Type | Description |
|---|---|
| String | The error code. "Null" when no error has occurred. |
Sample
var code = res.getErrorCode();
opensocial.ResponseItem.getErrorMessage
String getErrorMessage()
Returns an error message when an error has occurred.
Parameter
None
Return value
| Type | Description |
|---|---|
| String | Error message |
Sample
var msg = res.getErrorMessage();
opensocial.ResponseItem.getOriginalDataRequest
opensocial.DataRequest getOriginalDataRequest
Acquires the DataRequest used when this response was acquired.
Parameter
None
Return value
| Type | Description |
|---|---|
| opensocial.DataRequest | The DataRequest used when the response was acquired. |
Sample
var req = res.getOriginalDataRequest();
opensocial.ResponseItem.getData
Object getData()
Acquires the response data.
Parameter
None
Return value
| Type | Description |
|---|---|
| Object | Type is defined according to the request. |
Sample
var data = res.getData();
opensocial.ResponseItem.Error
opensocial.ResponseItem.Error.NOT_IMPLEMENTED
opensocial.ResponseItem.Error.UNAUTHORIZED
opensocial.ResponseItem.Error.FORBIDDEN
opensocial.ResponseItem.Error.BAD_REQUEST
opensocial.ResponseItem.Error.INTERNAL_ERROR
opensocial.ResponseItem.Error.LIMIT_EXCEEDED
Revision History
- 12/2010
- Initial Release.