opensocial.ResponseItem
Method
opensocial.ResponseItem.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
opensocial.ResponseItem.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
opensocial.ResponseItem.getErrorMessage
Returns an error message when an error has occurred.
Parameter
None
Return value
Type |
Description |
|---|---|
String |
Error message |
Sample
opensocial.ResponseItem.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
opensocial.ResponseItem.getData
Acquires the response data.
Parameter
None
Return value
Type |
Description |
|---|---|
Object |
Type is defined according to the request. |
Sample
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.