This repository has been archived by the owner on Sep 21, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 27
ModioResponse
Ahmed Castro edited this page Jan 9, 2018
·
15 revisions
The ModioResponse object is a struct 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.
struct ModioResponse
{
u32 code;
u32 result_count;
u32 result_limit;
i32 result_offset;
ModioError error;
};
C++ wrapper: Response
Name | Type | Description |
---|---|---|
code | u32 |
Http code returned by mod.io. |
cursor_id | u32 |
Cursor id supplied via the ModioFilterHandler. Defaults to -1 in case it was not supplied. See the API cursor documentation |
prev_id | u32 |
Previous cursor id supplied via the ModioFilterHandler. Defaults to -1 in case it was not supplied. See the API prev cursor documentation |
next_id | u32 |
Next cursor id to be supplied based on the current cursor supplied via the ModioFilterHandler. Defaults to -1 in case a cursor was not was not supplied. See the API cursor documentation |
result_count | u32 |
The number of results returned. |
error | ModioError error |
ModioError object containing the errors description in case |
See also: API Errors, API Response Codes, Response formats, API cursors and objects
- Home
- Table of Contents
- Getting Started
- SDK Methods
- Creators
- Editors
- Schemas
- modio::Avatar
- modio::Comment
- modio::Dependency
- modio::Download
- modio::Error
- modio::Filehash
- modio::Game
- modio::GameTagOption
- modio::Header
- modio::Icon
- modio::Image
- modio::InstalledMod
- modio::Logo
- modio::Media
- modio::MetadataKVP
- modio::Mod
- modio::ModEvent
- modio::Modfile
- modio::QueuedModDownload
- modio::QueuedModfileUpload
- modio::Rating
- modio::Response
- modio::Stats
- modio::Tag
- modio::User
- Debugging
- Constants
-
C Compatibility
- Methods
- Initialization, Process and Shutdown (C compatible)
- User Authentication (C compatible)
- Mods (C compatible)
- Modfiles (C compatible)
- Media (C compatible)
- Subscriptions (C compatible)
- Events (C compatible)
- Stats (C compatible)
- Tags (C compatible)
- Ratings (C compatible)
- Metadata KVP (C compatible)
- Dependencies (C compatible)
- Comments (C compatible)
- Reports (C compatible)
- Me (C compatible)
- Downloads (C compatible)
- Uploads (C compatible)
- Logs (C compatible)
- External Auth (C compatible)
- Configuration (C compatible)
- Creators
- Editors
- Schemas
- ModioAvatar
- ModioComment
- ModioDependency
- ModioDownload
- ModioError
- ModioFilehash
- ModioGame
- ModioGameTagOption
- ModioHeader
- ModioIcon
- ModioImage
- ModioInstalledMod
- ModioListNode
- ModioLogo
- ModioMedia
- ModioMetadataKVP
- ModioMod
- ModioModEvent
- ModioModfile
- ModioQueuedModDownload
- ModioQueuedModfileUpload
- ModioRating
- ModioResponse
- ModioStats
- ModioTag
- ModioUser
- Methods
- Building