modio::Response - modio/modio-sdk-legacy GitHub Wiki
The Response object is a class containing the response code, errors and cursor data form mod.io. This object is returned on every callback that interacts with mod.io and you can use it to check if your request was successful and to browse objects properly using the cursor filters.
class Response
{
public:
u32 code;
u32 result_count;
u32 result_limit;
i32 result_offset;
u32 result_total;
modio::Error error;
};
Name | Type | Description |
---|---|---|
code | u32 |
Http code returned by mod.io. |
result_count | u32 |
Number of results returned in the current request. |
result_limit | u32 |
Maximum number of results returned. Defaults to 100 unless overridden by _limit. |
result_offset | i32 |
Number of results skipped over. Defaults to 1 unless overridden by _offset. |
result_total | i32 |
Total number of results found. |
error | modio::Error |
modio::Error object containing the errors description in case |
See also: API Errors, API Response Codes, Response formats, API cursors and objects