Constructor and Description |
---|
Result(int code,
String id,
String message) |
Result(int code,
String id,
String message,
Parameters params) |
Modifier and Type | Method and Description |
---|---|
int |
getCode()
Returns the success or failure code for an API call.
A negative value indicates that an error.
|
String |
getId() |
String |
getID() |
ParametersIterator |
getIterator()
For an API like Functions.searchRecords() that can return zero or more records,
this API returns an iterator that can be used to loop over the list of Parameters
objects, each of which contains the data for one record.
(Use this API even if the call happens to return one record or none. |
String |
getMessage()
Returns the underlying message that accompanies a failure.
|
Parameters |
getParameters()
For an API like Functions.getRecord() that returns exactly one record,
use this to get the Parameters object that has the record data.
|
Iterator |
iterator() |
String |
toString() |
public Result(int code, String id, String message, Parameters params)
public int getCode()
public String getID()
public String getId()
public String getMessage()
public ParametersIterator getIterator()
public Parameters getParameters()