C++ Reference Docs

Functions

ToString

inline std::string ToString(Modio::MaturityOption option)

Transform an MaturityOption to an std::string

InitializeAsync

void InitializeAsync(Modio::InitializeOptions InitOptions, std::function<void (Modio::ErrorCode)> OnInitComplete)

Initializes the SDK for the given user. Loads the state of mods installed on the system as well as the set of mods the specified user has installed on this device

Parameters

InitOptions	Parameters to the function packed as a struct where all members needs to be initialized for the call to succeed

Error Values

GenericError::SDKAlreadyInitialized	SDK already initialized
NetworkError	Couldn't connect to the mod.io servers
FilesystemError	Couldn't create the user data or common data folders
ConfigurationError	InitOptions contains an invalid value - inspect ec.value() to determine what was incorrect

SetLogLevel

void SetLogLevel(Modio::LogLevel Level)

Sets the global logging level - messages with a log level below the specified value will not be displayed

Parameters

Level	Value indicating which priority of messages should be included in the log output

SetLogCallback

void SetLogCallback(std::function<void (Modio::LogLevel, const std::string &)> LogCallback)

Provide a callback to handle log messages emitted by the SDK.

Parameters

LogCallback	Callback invoked by the SDK during xref Modio::RunPendingHandlers for each log emitted during that invocation

RunPendingHandlers

void RunPendingHandlers()

Runs any pending SDK work on the calling thread, including invoking any callbacks passed to asynchronous operations. NOTE: This should be called while xref

Modio::InitializeAsync

and xref

Modio::ShutdownAsync

are running, as they both utilize the internal event loop for functionality. NOTE: RunPendingHandlers should never be called inside a callback you provide to the SDK. This will result in a deadlock.

ShutdownAsync

void ShutdownAsync(std::function<void (Modio::ErrorCode)> OnShutdownComplete)

Cancels any running internal operations and invokes any pending callbacks with Modio::GenericError::OperationCanceled. This function does not block; you should keep calling Modio::RunPendingHandlers until the callback you provide to this function is invoked. NOTE: ShutdownAsync should never be called inside a callback you provide to the SDK. This will result in a deadlock.

Requirements

• initialized-sdk

Parameters

OnShutdownComplete

Error Values

GenericError::SDKNotInitialized	SDK not initialized

SubscribeToModAsync

void SubscribeToModAsync(Modio::ModID ModToSubscribeTo, bool IncludeDependencies, std::function<void (Modio::ErrorCode)> OnSubscribeComplete)

Sends a request to the mod.io server to add the specified mod to the user's list of subscriptions, and marks the mod for local installation by the SDK

Requirements

• initialized-sdk
• authenticated-user
• no-rate-limiting
• management-enabled
• mod-not-pending-uninstall

Parameters

ModToSubscribeTo	Mod ID of the mod requiring a subscription.
IncludeDependencies	If this mod has any dependencies, all of those will also be subscribed to.
OnSubscribeComplete	Callback invoked when the subscription request is completed.

Error Values

GenericError::SDKNotInitialized	SDK not initialized
UserDataError::InvalidUser	No authenticated user
HttpError::RateLimited	Too many frequent calls to the API. Wait some time and try again.
ModManagementError::ModBeingProcessed	Specified mod is pending uninstall. Wait until the uninstall process is complete before subscribing again.
GenericError::BadParameter	The supplied mod ID is invalid
NetworkError	Couldn't connect to mod.io servers
EntityNotFoundError	Specified mod does not exist or was deleted

UnsubscribeFromModAsync

void UnsubscribeFromModAsync(Modio::ModID ModToUnsubscribeFrom, std::function<void (Modio::ErrorCode)> OnUnsubscribeComplete)

Sends a request to the mod.io server to remove the specified mod from the user's list of subscriptions. If no other local users are subscribed to the specified mod this function will also mark the mod for uninstallation by the SDK.

Requirements

• initialized-sdk
• authenticated-user
• no-rate-limiting
• management-enabled

Parameters

ModToUnsubscribeFrom	Mod ID of the mod requiring unsubscription.
OnUnsubscribeComplete	Callback invoked when the unsubscription request is completed.

Error Values

GenericError::SDKNotInitialized	SDK not initialized
UserDataError::InvalidUser	No authenticated user
HttpError::RateLimited	Too many frequent calls to the API. Wait some time and try again.
GenericError::BadParameter	The supplied mod ID is invalid
NetworkError	Couldn't connect to mod.io servers
EntityNotFoundError	Specified mod does not exist or was deleted

FetchExternalUpdatesAsync

void FetchExternalUpdatesAsync(std::function<void (Modio::ErrorCode)> OnFetchDone)

Synchronises the local list of the current user's subscribed mods with the server. Any mods that have been externally subscribed will be automatically marked for installation, and mods that have been externally removed from the user's subscriptions may be uninstalled if no other local users have a current subscription. Calling this before you call QueryUserSubscriptions, QueryUserInstallations orQuerySystemInstallations will ensure that if the system mod directory has been moved or relocated, those functions will still return correct values.

Requirements

• initialized-sdk
• authenticated-user
• no-rate-limiting
• management-enabled
• fetch-external-updates-not-running

Parameters

OnFetchDone	Callback invoked when the external state has been retrieved and merged with the local data

Error Values

GenericError::SDKNotInitialized	SDK not initialized
UserDataError::InvalidUser	No authenticated user
HttpError::RateLimited	Too many frequent calls to the API. Wait some time and try again.
GenericError::RequestInProgress	FetchExternalUpdates operation is already running.
NetworkError	Couldn't connect to mod.io servers

PreviewExternalUpdatesAsync

void PreviewExternalUpdatesAsync(std::function<void (Modio::ErrorCode, int)> OnPreviewDone)

Retrieve a list of updates between the users local mod state, and the server-side state. This allows you to identify which mods will be modified by the next call to FetchExternalUpdatesAsync in order to perform any content management (such as unloading files) that might be required.

Requirements

• initialized-sdk
• authenticated-user
• no-rate-limiting

Parameters

OnPreviewDone	Callback invoked when the external state has been retrieved. It contains a dictionary with ModID as keys and changes as values. Empty when there are no differences between local and the mod.io API service

Error Values

GenericError::SDKNotInitialized	SDK not initialized
UserDataError::InvalidUser	No authenticated user
HttpError::RateLimited	Too many frequent calls to the API. Wait some time and try again.
NetworkError	Couldn't connect to mod.io servers

EnableModManagement

Modio::ErrorCode EnableModManagement(std::function<void (Modio::ModManagementEvent)> ModManagementHandler)

Enables the automatic management of installed mods on the system based on the user's subscriptions. Does nothing if mod management is currently enabled. Note: this function does not behave like other "async" methods, given that its name does not include the word async.

Parameters

ModManagementHandler	This callback handler will be invoked with a ModManagementEvent for each mod operation performed by the SDK

Returns

Modio::ErrorCode indicating if mod management was enabled successfully

Error Values

GenericError::SDKNotInitialized	SDK not initialized
ModManagementError::ModManagementAlreadyEnabled	Mod management was already enabled. The mod management callback has not been changed

DisableModManagement

void DisableModManagement()

Disables automatic installation or uninstallation of mods based on the user's subscriptions. Allows currently processing installation to complete; will cancel any pending operations when called.

IsModManagementBusy

bool IsModManagementBusy()

Checks if the automatic management process is currently installing or removing mods

Returns

True if automatic management is currently performing an operation

PrioritizeTransferForMod

Modio::ErrorCode PrioritizeTransferForMod(Modio::ModID IDToPrioritize)

Prioritizes the specified mod for upload, install, or update. The priority mod will be processed immediately after the current upload or install completes (if applicable). Only one mod ID can be prioritized at a time.

Parameters

IDToPrioritize	The ID for the mod to prioritize. This mod must be pending upload, install, or update.

Returns

Error code indicating there is no pending upload, install, or update associated with the provided priority mod ID.

Error Values

GenericError::BadParameter	The supplied mod ID is invalid or not present in the list of pending operations

QueryCurrentModUpdate

int QueryCurrentModUpdate()

Provides progress information for a mod installation or update operation if one is currently in progress.

Returns

Optional ModProgressInfo object containing information regarding the progress of the installation operation.

QueryUserSubscriptions

int QueryUserSubscriptions()

Fetches the local view of the user's subscribed mods, including mods that are subscribed but not yet installed

Returns

std::map using Mod IDs as keys and ModCollectionEntry objects providing information about the subscribed mods

QueryUserInstallations

int QueryUserInstallations(bool bIncludeOutdatedMods)

Fetches the subset of the user's subscribed mods that are installed and therefore ready for loading

Parameters

bIncludeOutdatedMods	Include subscribed mods that are installed but have an updated version on the server that has not yet been installed

Returns

std::map using Mod IDs as keys and ModCollectionEntry objects providing information about the subscribed mods

QuerySystemInstallations

int QuerySystemInstallations()

Fetches all mods installed on the system such that a consuming application can present the information in a UI in order to free up space by uninstalling mods

Returns

std::map using Mod IDs as keys and ModCollectionEntry objects providing information about mods installed on the system regardless of which user installed them

QueryStorageInfo

Modio::StorageInfo QueryStorageInfo()

Retrieves a snapshot of current storage related information such as space consumed by mod installations and total available space

Returns

Structure containing storage information

ForceUninstallModAsync

void ForceUninstallModAsync(Modio::ModID ModToRemove, std::function<void (Modio::ErrorCode)> Callback)

Forcibly uninstalls a mod from the system. This is intended for use when a host application requires more room for a mod that the user wants to install, and as such will return an error if the current user is subscribed to the mod. To remove a mod the current user is subscribed to, use xref

Modio::UnsubscribeFromModAsync

.

Parameters

ModToRemove	The ID for the mod to force remove.
Callback	Callback invoked when the uninstallation is successful, or if it failed because the current user remains subscribed.

Error Values

GenericError::SDKNotInitialized	SDK not initialized
UserDataError::InvalidUser	No authenticated user
ModManagementError::AlreadySubscribed	User is still subscribed to the specified mod
GenericError::BadParameter	The supplied mod ID is invalid

VerifyUserAuthenticationAsync

void VerifyUserAuthenticationAsync(std::function<void (Modio::ErrorCode)> Callback)

Queries the server to verify the state of the currently authenticated user if there is one present. An empty ErrorCode passed to the callback indicates successful verification, i.e. the mod.io server was contactable and the user's authentication remains valid.

Requirements

• initialized-sdk
• no-rate-limiting
• authenticated-user

Parameters

Callback	Callback invoked once the server-side state has been queried

Error Values

GenericError::SDKNotInitialized	SDK not initialized
UserDataError::InvalidUser	No authenticated user
NetworkError	Couldn't connect to mod.io servers

RefreshUserDataAsync

void RefreshUserDataAsync(std::function<void (Modio::ErrorCode)> Callback)

Queries the server to update the user data. An empty ErrorCode passed to the callback indicates successful verification, i.e. the mod.io server was contactable and the user's data got updated.

Requirements

• initialized-sdk
• no-rate-limiting
• authenticated-user

Parameters

Callback	Callback invoked once the server-side state has been queried

Error Values

GenericError::SDKNotInitialized	SDK not initialized
UserDataError::InvalidUser	No authenticated user
HttpError::RateLimited	Too many frequent calls to the API. Wait some time and try again.
NetworkError	Couldn't connect to mod.io servers

QueryUserProfile

int QueryUserProfile()

Fetches the currently authenticated mod.io user profile if there is one associated with the current platform user

Returns

Optional Modio::User object containing profile information

AuthenticateUserExternalAsync

void AuthenticateUserExternalAsync(Modio::AuthenticationParams User, Modio::AuthenticationProvider Provider, std::function<void (Modio::ErrorCode)> Callback)

Uses platform-specific authentication to associate a mod.io user account with the current platform user

Requirements

• initialized-sdk
• no-rate-limiting
• no-authenticated-user

Parameters

User	Authentication payload data to submit to the provider. Any AuthToken string that contains special characters (ex. "+, /, =") requires the boolean "bURLEncodeAuthToken" set as "True" to encode the text accordingly
Provider	The provider to use to perform the authentication
Callback	Callback invoked once the authentication request has been made

Error Values

GenericError::SDKNotInitialized	SDK not initialized
HttpError::RateLimited	Too many frequent calls to the API. Wait some time and try again.
NetworkError	Couldn't connect to mod.io servers
ConfigurationError	The SDK's configuration is not valid
InvalidArgsError	The arguments passed to the function have failed validation
UserTermsOfUseError	The user has not yet accepted the mod.io Terms of Use

GetTermsOfUseAsync

void GetTermsOfUseAsync(std::function<void (Modio::ErrorCode, int)> Callback)

This function retrieves the information required for a game to display the mod.io terms of use to a player who wishes to create a mod.io account

Requirements

• initialized-sdk

Parameters

Callback	Callback invoked with the terms of use data once retrieved from the server

Error Values

GenericError::SDKNotInitialized	SDK not initialized
HttpError::RateLimited	Too many frequent calls to the API. Wait some time and try again.
NetworkError	Couldn't connect to mod.io servers

GetModCreationHandle

Modio::ModCreationHandle GetModCreationHandle()

Returns a handle for use with SubmitNewModAsync

Returns

The handle to use in a call to SubmitNewModAsync

SubmitNewModAsync

void SubmitNewModAsync(Modio::ModCreationHandle Handle, Modio::CreateModParams Params, std::function<void (Modio::ErrorCode, int)> Callback)

Requests a new mod be created with the specified properties

Requirements

• initialized-sdk
• no-rate-limiting
• authenticated-user

Parameters

Handle	Handle returned by xref Modio::GetModCreationHandle . Each successful call to SubmitNewModAsync requires a new ModCreationHandle.
Params	Information about the mod to be created
Callback	Callback invoked with the ID of the created mod once the parameters are validated by the server and the mod is created

Error Values

GenericError::SDKNotInitialized	SDK not initialized
UserDataError::InvalidUser	No authenticated user
NetworkError	Couldn't connect to mod.io servers
InvalidArgsError	Some of the information in the ModCreateParams did not pass validation

SubmitModChangesAsync

void SubmitModChangesAsync(Modio::ModID Mod, Modio::EditModParams Params, std::function<void (Modio::ErrorCode, int)> Callback)

Edits the parameters of a mod, by updating any fields set in the Params object to match the passed-in values. Fields left empty on the Params object will not be updated. If no fields are populated, will return an error.

Requirements

• initialized-sdk
• no-rate-limiting
• authenticated-user

Parameters

Mod	The mod to edit
Params	Descriptor containing optional fields indicating what properties should be updated
Callback	Callback invoked with the updated mod profile on success

Error Values

GenericError::SDKNotInitialized	SDK not initialized
UserDataError::InvalidUser	No authenticated user
GenericError::BadParameter	No fields selected for modification in Params, or the supplied mod ID is invalid
NetworkError	Couldn't connect to mod.io servers
InvalidArgsError	Some of the information in the EditModParams did not pass validation

SubmitNewModFileForMod

void SubmitNewModFileForMod(Modio::ModID Mod, Modio::CreateModFileParams Params)

Queues the upload of a new modfile release for the specified mod using the submitted parameters. This function takes a Modio::CreateModFileParams object specifying a path to the root folder of the new modfile. The SDK will compress the folder's contents into a .zip archive and queue the result for upload. When the upload completes, a Mod Management Event will be triggered. Note the SDK is also responsible for decompressing the archive upon its installation at a later point in time.

Requirements

• initialized-sdk
• no-rate-limiting
• authenticated-user
• management-enabled

Parameters

Mod	The mod to attach the modfile to
Params	Descriptor containing information regarding the modfile

Error Values

GenericError::BadParameter	The supplied mod ID is invalid

ListAllModsAsync

void ListAllModsAsync(Modio::FilterParams Filter, std::function<void (Modio::ErrorCode, int)> Callback)

Provides a list of mods for the current game, that match the parameters specified in the filter

Requirements

• initialized-sdk
• no-rate-limiting

Parameters

Filter	Modio::FilterParams object containing any filters that should be applied to the query
Callback	Callback invoked with a status code and an optional ModInfoList providing mod profiles

Error Values

GenericError::SDKNotInitialized	SDK not initialized
HttpError::RateLimited	Too many frequent calls to the API. Wait some time and try again.
NetworkError	Couldn't connect to mod.io servers

GetModInfoAsync

void GetModInfoAsync(Modio::ModID ModId, std::function<void (Modio::ErrorCode, int)> Callback)

Fetches detailed information about the specified mod, including description and file metadata for the most recent release

Requirements

• initialized-sdk
• no-rate-limiting

Parameters

ModId	Mod ID of the mod to fetch data
Callback	Callback providing a status code and an optional Modio::ModInfo object with the mod's extended information

Error Values

GenericError::SDKNotInitialized	SDK not initialized
HttpError::RateLimited	Too many frequent calls to the API. Wait some time and try again.
GenericError::BadParameter	The supplied mod ID is invalid
NetworkError	Couldn't connect to mod.io servers
EntityNotFoundError	Specified mod does not exist or was deleted

GetModMediaAsync

void GetModMediaAsync(Modio::ModID ModId, Modio::LogoSize LogoSize, std::function<void (Modio::ErrorCode, int)> Callback)

Downloads the logo for the specified mod. Will use existing file if it is already present on disk

Requirements

• initialized-sdk
• no-rate-limiting

Parameters

ModId	Mod ID for use in logo retrieval
LogoSize	Parameter indicating the size of logo that's required
Callback	Callback providing a status code and an optional path object pointing to the location of the downloaded image

Error Values

GenericError::SDKNotInitialized	SDK not initialized
FilesystemError::InsufficientSpace	Not enough space for the file
HttpError::RateLimited	Too many frequent calls to the API. Wait some time and try again.
GenericError::BadParameter	The supplied mod ID is invalid
NetworkError	Couldn't connect to mod.io servers
EntityNotFoundError	Specified mod media does not exist or was deleted

GetModMediaAsync

void GetModMediaAsync(Modio::ModID ModId, Modio::GallerySize GallerySize, Modio::GalleryIndex Index, std::function<void (Modio::ErrorCode, int)> Callback)

Get a gallery image for the specified mod ID. If it already exists on disk the file will be reused unless it is outdated

Requirements

• initialized-sdk
• no-rate-limiting

Parameters

ModId	The mod you want to retrieve an image for
GallerySize	Size of the image you want to retrieve
Index	The zero-based index of the image you want to retrieve
Callback	Callback containing a status code and an Optional containing a path to the image file on disk

Error Values

GenericError::SDKNotInitialized	SDK not initialized
FilesystemError::InsufficientSpace	Not enough space for the file
HttpError::RateLimited	Too many frequent calls to the API. Wait some time and try again.
GenericError::BadParameter	The supplied mod ID is invalid
NetworkError	Couldn't connect to mod.io servers
EntityNotFoundError	Specified mod media does not exist or was deleted

GetModMediaAsync

void GetModMediaAsync(Modio::ModID ModId, Modio::AvatarSize AvatarSize, std::function<void (Modio::ErrorCode, int)> Callback)

Downloads the creator avatar for a specified mod. Will use existing file if it is already present on disk and not outdated

Requirements

• initialized-sdk
• no-rate-limiting

Parameters

ModId	ID of the mod the creator avatar will be retrieved for
AvatarSize	Parameter indicating the size of avatar image that's required
Callback	Callback providing a status code and an optional path object pointing to the location of the downloaded image

Error Values

GenericError::SDKNotInitialized	SDK not initialized
FilesystemError::InsufficientSpace	Not enough space for the file
HttpError::RateLimited	Too many frequent calls to the API. Wait some time and try again.
GenericError::BadParameter	The supplied mod ID is invalid
NetworkError	Couldn't connect to mod.io servers
EntityNotFoundError	Specified mod media does not exist or was deleted

SubmitModRatingAsync

void SubmitModRatingAsync(Modio::ModID ModID, Modio::Rating Rating, std::function<void (Modio::ErrorCode)> Callback)

Submits a rating for a mod on behalf of the currently authenticated user.

Requirements

• initialized-sdk
• no-rate-limiting
• authenticated-user

Parameters

ModID	The mod to submit a rating for
Rating	The rating to submit NOTE: To clear a rating for a mod, submit a rating of Rating::Neutral.
Callback	Callback providing a status code to indicate the rating was submitted successfully

Error Values

GenericError::SDKNotInitialized	SDK not initialized
UserDataError::InvalidUser	No authenticated user
HttpError::RateLimited	Too many frequent calls to the API. Wait some time and try again.
GenericError::BadParameter	The supplied mod ID is invalid
NetworkError	Couldn't connect to mod.io servers
EntityNotFoundError	Specified mod could not be found

GetModTagOptionsAsync

void GetModTagOptionsAsync(std::function<void (Modio::ErrorCode, int)> Callback)

Fetches the available tags used on mods for the current game. These tags can them be used in conjunction with the FilterParams passed to ListAllMods

Requirements

• initialized-sdk
• no-rate-limiting

Parameters

Callback	Callback providing a status code and an optional ModTagOptions object containing the available tags

Error Values

GenericError::SDKNotInitialized	SDK not initialized
HttpError::RateLimited	Too many frequent calls to the API. Wait some time and try again.
NetworkError	Couldn't connect to mod.io servers

GetModDependenciesAsync

void GetModDependenciesAsync(Modio::ModID ModID, bool Recursive, std::function<void (Modio::ErrorCode, int)> Callback)

For a given Mod ID, fetches a list of any mods that the creator has marked as dependencies

Requirements

• initialized-sdk
• no-rate-limiting

Parameters

ModID	The mod to retrieve dependencies for
Recursive	Include child dependencies in a recursive manner. NOTE: Recursion supports a maximum depth of 5.
Callback	Callback providing a status code and an optional xref ModDependencyList

Error Values

GenericError::SDKNotInitialized	SDK not initialized
HttpError::RateLimited	Too many frequent calls to the API. Wait some time and try again.
GenericError::BadParameter	The supplied mod ID is invalid
NetworkError	Couldn't connect to mod.io servers

AddModDependenciesAsync

void AddModDependenciesAsync(Modio::ModID ModID, int Dependencies, std::function<void (Modio::ErrorCode)> Callback)

Adds dependencies to a specified mod, linking it with other mods that are required for it to function

Requirements

• initialized-sdk
• no-rate-limiting
• authenticated-user

Parameters

ModID	The mod to add dependencies to
Dependencies	List of mod dependencies to add
Callback	Callback providing a status code to indicate if the dependencies were added successfully

Error Values

GenericError::SDKNotInitialized	SDK not initialized
UserDataError::InvalidUser	No authenticated user
HttpError::RateLimited	Too many frequent calls to the API. Wait some time and try again.
GenericError::BadParameter	The supplied mod ID is invalid
NetworkError	Couldn't connect to mod.io servers
EntityNotFoundError	Specified mod could not be found

DeleteModDependenciesAsync

void DeleteModDependenciesAsync(Modio::ModID ModID, int Dependencies, std::function<void (Modio::ErrorCode)> Callback)

Deletes dependencies from a specified mod, unlinking it from other mods that are no longer required.

Requirements

• initialized-sdk
• no-rate-limiting
• authenticated-user

Parameters

ModID	The mod to delete dependencies from
Dependencies	List of mod IDs to delete as dependencies
Callback	Callback providing a status code to indicate if the dependencies were deleted successfully

Error Values

GenericError::SDKNotInitialized	SDK not initialized
UserDataError::InvalidUser	No authenticated user
HttpError::RateLimited	Too many frequent calls to the API. Wait some time and try again.
GenericError::BadParameter	The supplied mod IDs are invalid
NetworkError	Couldn't connect to mod.io servers

RequestEmailAuthCodeAsync

void RequestEmailAuthCodeAsync(Modio::EmailAddress EmailAddress, std::function<void (Modio::ErrorCode)> Callback)

Begins email authentication for the current session by requesting a one-time code be sent to the specified email address if it is associated with a mod.io account

Requirements

• initialized-sdk
• no-rate-limiting
• no-authenticated-user

Parameters

EmailAddress	The email address to send the code to
Callback	Callback providing a status code indicating the outcome of the request

Error Values

GenericError::SDKNotInitialized	SDK not initialized
UserAuthError::AlreadyAuthenticated	Authenticated user already signed-in. Call ClearUserDataAsync to de-authenticate the old user, then Shutdown() and reinitialize the SDK first.
HttpError::RateLimited	Too many frequent calls to the API. Wait some time and try again.
NetworkError	Couldn't connect to mod.io servers

AuthenticateUserEmailAsync

void AuthenticateUserEmailAsync(Modio::EmailAuthCode AuthenticationCode, std::function<void (Modio::ErrorCode)> Callback)

Completes email authentication for the current session by submitting the one-time code sent to the user's email address

Requirements

• initialized-sdk
• no-rate-limiting
• no-authenticated-user

Parameters

AuthenticationCode	User's authentication code
Callback	Callback providing a status code indicating if authentication was successful or not

Error Values

GenericError::SDKNotInitialized	SDK not initialized
UserAuthError::AlreadyAuthenticated	Authenticated user already signed-in. Call ClearUserDataAsync to de-authenticate the old user, then Shutdown() and reinitialize the SDK first.
HttpError::RateLimited	Too many frequent calls to the API. Wait some time and try again.
NetworkError	Couldn't connect to mod.io servers

ClearUserDataAsync

void ClearUserDataAsync(std::function<void (Modio::ErrorCode)> Callback)

De-authenticates the current mod.io user for the current session, and clears all user-specific data stored on the current device. Any subscribed mods that are installed but do not have other local users subscribed will be marked for uninstallation. This method also disables mod management.

Requirements

• initialized-sdk
• authenticated-user

Parameters

Callback	Callback providing a status code indicating the outcome of clearing the user data. Error codes returned by this function are informative only - it will always succeed.

Error Values

GenericError::SDKNotInitialized	SDK not initialized
UserDataError::InvalidUser	No authenticated user
HttpError::RateLimited	Too many frequent calls to the API. Wait some time and try again.

GetUserMediaAsync

void GetUserMediaAsync(Modio::AvatarSize AvatarSize, std::function<void (Modio::ErrorCode, int)> Callback)

Downloads the avatar of the currently authenticated user. Will only perform a download if there is no local cache of the avatar or if that cached copy is out-of-date.

Requirements

• initialized-sdk
• no-rate-limiting
• authenticated-user

Parameters

AvatarSize	Parameter specifying the size of avatar image to download
Callback	Callback providing a status code for the download and an optional path to the downloaded image

Error Values

GenericError::SDKNotInitialized	SDK not initialized
UserDataError::InvalidUser	No authenticated user
HttpError::RateLimited	Too many frequent calls to the API. Wait some time and try again.
NetworkError	Couldn't connect to mod.io servers

GetLastValidationError

int GetLastValidationError()

If the last request to the mod.io servers returned a validation failure, this function returns extended information describing the fields that failed validation.

Requirements

• initialized-sdk

Returns

Collection of Modio::FieldError objects, or empty collection if there was no validation failures

ReportContentAsync

void ReportContentAsync(Modio::ReportParams Report, std::function<void (Modio::ErrorCode)> Callback)

Sends a content report to mod.io. When using this function, please inform your users that if they provide their contact name or details in the Report parameter, that those may be shared with the person responsible for the content being reported. For more information on what data in a report will be shared with whom, please see link: our website's report form for more information.

Requirements

• initialized-sdk

Parameters

Report	Information about the content being reported and a description of the report.
Callback	Callback providing a status code to indicate successful submission of the report.

Error Values

HttpError::RateLimited	Too many frequent calls to the API. Wait some time and try again.
GenericError::BadParameter	The mod ID, game ID, or user ID supplied to ReportParams is invalid
NetworkError	Couldn't Connect to mod.io servers
InvalidArgsError	Required information in the report did not pass validation

AddOrUpdateModLogoAsync

void AddOrUpdateModLogoAsync(Modio::ModID ModID, std::string LogoPath, std::function<void (Modio::ErrorCode)> Callback)

Submit a new logo for an existing mod, overriding any existing image currently stored on the server. The logo must be gif, jpg, or png format and cannot exceed 8MB in filesize. Dimensions must be at least 512x288. We recommended you supply a high resolution image with a 16:9 ratio. mod.io will use this logo to create three thumbnails with the dimensions of 320x180, 640x360 and 1280x720.

Requirements

• initialized-sdk
• no-rate-limiting
• authenticated-user

Parameters

ModID	ID of the mod whose logo will be added or updated
LogoPath	Path to the new image file of the logo to be uploaded.
Callback	Callback providing a status code indicating the outcome of the request

Error Values

GenericError::SDKNotInitialized	SDK not initialized
UserDataError::InvalidUser	No authenticated user
HttpError::RateLimited	Too many frequent calls to the API. Wait some time and try again.
GenericError::BadParameter	The supplied mod ID is invalid

AddOrUpdateModGalleryImagesAsync

void AddOrUpdateModGalleryImagesAsync(Modio::ModID ModID, int ImagePaths, bool SyncGallery, std::function<void (Modio::ErrorCode)> Callback)

Add or update images in the gallery for an existing mod. Images must be gif, jpg, or png format and cannot exceed 8MB in filesize.

Requirements

• initialized-sdk
• no-rate-limiting
• authenticated-user

Parameters

ModID	ID of the mod whose gallery images will be added or updated
ImagePaths	Vector of paths to the image files to be uploaded
SyncGallery	If true, existing gallery images will be replaced; if false, new images will be appended
Callback	Callback providing a status code indicating the outcome of the request

Error Values

GenericError::SDKNotInitialized	SDK not initialized
UserDataError::InvalidUser	No authenticated user
HttpError::RateLimited	Too many frequent calls to the API. Wait some time and try again.
GenericError::BadParameter	The supplied mod ID is invalid

ArchiveModAsync

void ArchiveModAsync(Modio::ModID ModID, std::function<void (Modio::ErrorCode)> Callback)

Archives a mod. This mod will no longer be able to be viewed or retrieved via the SDK, but it will still exist should you choose to restore it at a later date. Archiving is restricted to team managers and administrators only. Note that restoration and permanent deletion of a mod is possible only via web interface.

Requirements

• authenticated-user
• initialized-sdk
• no-rate-limiting

Parameters

ModID	The mod to be archived.

Error Values

ApiError::InsufficientPermission	The authenticated user does not have permission to archive this mod. This action is restricted to team managers and administrators only.
GenericError::SDKNotInitialized	SDK not initialized
GenericError::BadParameter	The supplied mod ID is invalid
APIError::CannotArchiveModWithDependents	This mod is a dependency of other mods and as such cannot be archived
NetworkError	Couldn't connect to mod.io servers
EntityNotFoundError	Specified mod does not exist or was deleted

ListUserCreatedModsAsync

void ListUserCreatedModsAsync(Modio::FilterParams Filter, std::function<void (Modio::ErrorCode, int)> Callback)

Provides a list of mods that the user has submitted, or is a team member for, for the current game, applying the parameters specified in the filter

Requirements

• authenticated-user
• initialized-sdk
• no-rate-limiting

Parameters

Filter	Modio::FilterParams object containing any filters that should be applied to the query
Callback	Callback invoked with a status code and an optional ModInfoList providing mod profiles

Error Values

GenericError::SDKNotInitialized	SDK not initialized
HttpError::RateLimited	Too many frequent calls to the API. Wait some time and try again.
NetworkError	Couldn't connect to mod.io servers

GetBaseModInstallationDirectories

int GetBaseModInstallationDirectories()

Returns a list of base mod installation directories. Under normal circumstances, this will return a single directory, which is the base directory that all mods are installed to for the current user.

Requirements

• initialized-sdk

Returns

List of base mod installation directories

GetDefaultModInstallationDirectory

std::string GetDefaultModInstallationDirectory(Modio::GameID GameID)

Returns the default mod installation directory for this game and platform, ignoring overrides and without requiring the SDK to be initialized.

Parameters

GameID	The Modio::GameID of the game we're fetching the default mod installation directory for.

Returns

The default mod installation directory for the specified game on the current platform

MuteUserAsync

void MuteUserAsync(Modio::UserID UserID, std::function<void (Modio::ErrorCode)> Callback)

Mute a user. This will prevent mod.io from returning mods authored by the muted user. when performing searches.

Requirements

• authenticated-user
• initialized-sdk

Parameters

UserID	ID of the User to mute

Error Values

GenericError::SDKNotInitialized	SDK not initialized
UserDataError::InvalidUser	No authenticated user
GenericError::BadParameter	The supplied user ID is invalid

UnmuteUserAsync

void UnmuteUserAsync(Modio::UserID UserID, std::function<void (Modio::ErrorCode)> Callback)

Unmute a user. This will allow mod.io to mods authored by the previously muted user. when performing searches.

Requirements

• authenticated-user
• initialized-sdk

Parameters

UserID	ID of the User to unmute

Error Values

GenericError::SDKNotInitialized	SDK not initialized
UserDataError::InvalidUser	No authenticated user
GenericError::BadParameter	The supplied user ID is invalid

GetMutedUsersAsync

void GetMutedUsersAsync(std::function<void (Modio::ErrorCode, int)> Callback)

List all the users that have been muted by the current user.

Requirements

• authenticated-user
• initialized-sdk

Error Values

GenericError::SDKNotInitialized	SDK not initialized
UserDataError::InvalidUser	No authenticated user

GetGameInfoAsync

void GetGameInfoAsync(Modio::GameID GameID, std::function<void (Modio::ErrorCode, int)> Callback)

Fetches detailed information about the specified game

Requirements

• initialized-sdk

Parameters

GameID	Game ID of the game data to fetch
Callback	Callback providing a status code and an optional Modio::GameInfo object to store the games's extended information

Error Values

GenericError::SDKNotInitialized	SDK not initialized
HttpError::RateLimited	Too many frequent calls to the API. Wait some time and try again.
UserDataError::InvalidUser	No authenticated user
GenericError::BadParameter	The supplied game ID is invalid
NetworkError	Couldn't connect to mod.io servers
EntityNotFoundError	Specified game does not exist

ListUserGamesAsync

void ListUserGamesAsync(Modio::FilterParams Filter, std::function<void (Modio::ErrorCode, int)> Callback)

Provides a list of games for the current user, that match the parameters specified in the filter

Requirements

• initialized-sdk
• no-rate-limiting
• user-authenticated

Parameters

Filter	Modio::FilterParams object containing any filters that should be applied to the query
Callback	Callback invoked with a status code and an optional GameInfoList providing game infos

Error Values

GenericError::SDKNotInitialized	SDK not initialized
HttpError::RateLimited	Too many frequent calls to the API. Wait some time and try again.
NetworkError	Couldn't connect to mod.io servers

GetUserRatingsAsync

void GetUserRatingsAsync(std::function<void (Modio::ErrorCode, int)> Callback)

Provides a list of mod ratings for the current user

Requirements

• initialized-sdk
• no-rate-limiting
• user-authenticated

Parameters

Callback	Callback invoked with a status code and an optional UserRatingList providing ratings for each mod

Error Values

GenericError::SDKNotInitialized	SDK not initialized
HttpError::RateLimited	Too many frequent calls to the API. Wait some time and try again.
NetworkError	Couldn't connect to mod.io servers

PurchaseModAsync

void PurchaseModAsync(Modio::ModID ModID, uint64_t ExpectedPrice, std::function<void (Modio::ErrorCode, int)> Callback)

Attempts to purchase a specified mod with an expected price. Purchasing a mod will add a subscription to it

Requirements

• initialized-sdk
• authenticated-user
• no-rate-limiting

Parameters

ModID	The ID for the mod the user is trying to purchase
ExpectedPrice	The price that was displayed to the user.
Callback	Callback providing a status code and optional transaction confirmation if the purchase was successful. If the expected price that was displayed to the end user is no longer correct, for example if the price was increased or decreased by the mod creator since the price was displayed, an error will be returned. If this is the case you should refresh your user interface with the updated price and the user can retry the purchase at the new value.

Error Values

GenericError::SDKNotInitialized	SDK not initialized
HttpError::RateLimited	Too many frequent calls to the API. Wait some time and try again.
UserDataError::InvalidUser	No authenticated user
GenericError::BadParameter	The supplied mod ID is invalid
NetworkError	Couldn't connect to mod.io servers
MonetizationError	Problems during purchase transaction

RefreshUserEntitlementsAsync

void RefreshUserEntitlementsAsync(Modio::EntitlementParams Params, std::function<void (Modio::ErrorCode, int)> Callback)

Requests mod.io consume available entitlements for the current authenticated user purchased through the current portal.

Requirements

• initialized-sdk
• authenticated-user
• no-rate-limiting

Parameters

Params	Additional parameters
Callback	Callback providing an error code indicating success or failure of the refresh operation

Error Values

GenericError::SDKNotInitialized	SDK not initialized
HttpError::RateLimited	Too many frequent calls to the API. Wait some time and try again.
UserDataError::InvalidUser	No authenticated user
MonetizationError::RetryEntitlements	Some entitlements could not be verified. Wait some time and try again.
NetworkError	Couldn't connect to mod.io servers
MonetizationError	Problems during purchase transaction

FetchUserPurchasesAsync

void FetchUserPurchasesAsync(std::function<void (Modio::ErrorCode)> OnFetchDone)

Fetches a list of all purchases that a User has made. Query the list using QueryUserPurchasedMods after a successful call.

Requirements

• initialized-sdk
• authenticated-user
• no-rate-limiting

Parameters

OnFetchDone	Callback invoked with a status code for whether the fetch was successful

Error Values

GenericError::SDKNotInitialized	SDK not initialized
HttpError::RateLimited	Too many frequent calls to the API. Wait some time and try again.
UserDataError::InvalidUser	No authenticated user
NetworkError	Couldn't connect to mod.io servers
MonetizationError	Problems during purchase transaction

QueryUserPurchasedMods

int QueryUserPurchasedMods()

Fetches the locally cached view of the user's purchased mods, populated fromRefreshUserPurchasesAsync

Returns

std::map using Mod IDs as keys and ModInfo objects providing information about the mod that was purchased. mods

GetUserDelegationTokenAsync

void GetUserDelegationTokenAsync(std::function<void (Modio::ErrorCode, std::string)> Callback)

Gets a UserDelegationToken that can be used by a backend serve for S2S functionality.

Requirements

• initialized-sdk
• authenticated-user
• no-rate-limiting

Error Values

GenericError::SDKNotInitialized	SDK not initialized
HttpError::RateLimited	Too many frequent calls to the API. Wait some time and try again.
UserDataError::InvalidUser	No authenticated user
NetworkError	Couldn't connect to mod.io servers
MonetizationError	Problems during purchase transaction

InitTempModSet

Modio::ErrorCode InitTempModSet(int ModIds)

Initialize a Temp Mod Set, installing every specified mod given in the param if they are not already subbed.

Parameters

ModIds	vector of ModID to install as temp mod

Returns

Modio::ErrorCode indicating if temp mod correctly started

Error Values

GenericError::SDKNotInitialized	SDK not initialized
ModManagementError::ModManagementDisabled	Mod Management need to be enabled

AddToTempModSet

Modio::ErrorCode AddToTempModSet(int ModIds)

Add mods to an already created Temp Mod Session, install every temp mod given in the param if they already subbed or already in Temp Mod Set

Parameters

ModIds	vector of ModID to install as temp mod

Returns

Modio::ErrorCode indicating if temp mod correctly started

Error Values

GenericError::SDKNotInitialized	SDK not initialized
ModManagementError::ModManagementDisabled	Mod Management need to be enabled
ModManagementError::TempModSetNotInitialized	Temp Mod Set is not initialize, call InitTempModSet.

RemoveFromTempModSet

Modio::ErrorCode RemoveFromTempModSet(int ModIds)

Delete mods to an already created Temp Mod Session, delete every temp mods given in the param if they already subbed mod, it will not delete them.

Parameters

ModIds	vector of ModID to install as temp mod

Returns

Modio::ErrorCode indicating if temp mod correctly started

Error Values

GenericError::SDKNotInitialized	SDK not initialized
ModManagementError::ModManagementDisabled	Mod Management need to be enabled
ModManagementError::TempModSetNotInitialized	Temp Mod Set is not initialize, call InitTempModSet.

CloseTempModSet

Modio::ErrorCode CloseTempModSet()

Close a Temp Mod Session, delete all temp mods

Returns

Modio::ErrorCode indicating if temp mod correctly started

Error Values

GenericError::SDKNotInitialized	SDK not initialized
ModManagementError::ModManagementDisabled	Mod Management need to be enabled
ModManagementError::TempModSetNotInitialized	Temp Mod Set is not initialize, call InitTempModSet.

QueryTempModSet

int QueryTempModSet()

Fetches the temp mod added to Temp Mod Set

Returns

std::map using Mod IDs as keys and ModCollectionEntry objects providing information about the mods added to temp mod set

MetricsSessionStartAsync

Premium Feature

This functionality requires the Metrics premium feature. Please contact your mod.io representative for details on how to enable it.

Experimental Feature

This function is part of an experimental feature and is subject to change.

void MetricsSessionStartAsync(Modio::MetricsSessionParams Params, std::function<void (Modio::ErrorCode)> Callback)

Start a Metrics play session

Parameters

Params	Modio::MetricsServiceParams object containing information of what and how to start a metrics session
Callback	Callback providing an error code indicating success or failure of the session start operation

Error Values

GenericError::SDKNotInitialized	SDK not initialized
HttpError::RateLimited	Too many frequent calls to the API. Wait some time and try again.
UserDataError::InvalidUser	No authenticated user
MetricsError::SessionNotInitialized	Metrics session has not yet been initialized
MetricsError::SessionIsActive	Metrics session is currently active and running
GenericError::BadParameter	One or more values in the Metric Session Parameters are invalid

MetricsSessionSendHeartbeatOnceAsync

Premium Feature

This functionality requires the Metrics premium feature. Please contact your mod.io representative for details on how to enable it.

Experimental Feature

This function is part of an experimental feature and is subject to change.

void MetricsSessionSendHeartbeatOnceAsync(std::function<void (Modio::ErrorCode)> Callback)

Sends a single heartbeat to the mod.io server to indicate a session is still active

Parameters

Callback	Callback providing an error code indicating success or failure of the session heartbeat operation

Error Values

GenericError::SDKNotInitialized	SDK not initialized
UserDataError::InvalidUser	No authenticated user
MetricsError::SessionNotInitialized	Metrics session has not yet been initialized
MetricsError::SessionIsNotActive	Metrics session is not currently running. Call MetricsSessionStartAsync before attempting to sending a heartbeat.

MetricsSessionSendHeartbeatAtIntervalAsync

Premium Feature

This functionality requires the Metrics premium feature. Please contact your mod.io representative for details on how to enable it.

Experimental Feature

This function is part of an experimental feature and is subject to change.

void MetricsSessionSendHeartbeatAtIntervalAsync(uint32_t IntervalSeconds, std::function<void (Modio::ErrorCode)> Callback)

Sends a constant heartbeat at a given interval to the mod.io server to indicate a session is still active

Parameters

IntervalSeconds	The frequency in seconds to send a heartbeat to the mod.io server
Callback	Callback providing an error code indicating success or failure of the session heartbeat operation

Error Values

GenericError::SDKNotInitialized	SDK not initialized
UserDataError::InvalidUser	No authenticated user
MetricsError::SessionNotInitialized	Metrics session has not yet been initialized
MetricsError::SessionIsNotActive	Metrics session is not currently running. Call MetricsSessionStartAsync before attempting to sending a heartbeat.

MetricsSessionEndAsync

Premium Feature

This functionality requires the Metrics premium feature. Please contact your mod.io representative for details on how to enable it.

Experimental Feature

This function is part of an experimental feature and is subject to change.

void MetricsSessionEndAsync(std::function<void (Modio::ErrorCode)> Callback)

Ends a Metrics play session

Parameters

Callback	Callback providing an error code indicating success or failure of the session end operation

Error Values

GenericError::SDKNotInitialized	SDK not initialized
HttpError::RateLimited	Too many frequent calls to the API. Wait some time and try again.
UserDataError::InvalidUser	No authenticated user
MetricsError::SessionNotInitialized	Metrics session has not yet been initialized
MetricsError::SessionIsNotActive	Metrics session is not currently running. Call MetricsSessionStartAsync before attempting to end a session.

Classes

ErrorCode

Trivial wrapper around link:https://en.cppreference.com/w/cpp/error/error_code[std::error_code]. Implemented as a class instead of a type alias to allow it to be forward-declared in wrappers, eg the UE4 plugin.

Functions

ErrorCode

ErrorCode(std::error_code ec)

Error code constructor using std::error_code

ErrorCode

ErrorCode()

Error code constructor using an empty value

FlagImpl

Helper class to strongly type bitfield operations

Functions

Variables

int	Internal

List

Templated helper class to wrap a dynamic collection of elements

Functions

GetRawList

const ListType &GetRawList() const

Retrieve the raw list as a const reference

GetRawList

ListType &GetRawList()

Retrieve the raw list as a reference

Size

std::size_t Size() const

Retrieve the size of the internal list

Variables

ListType	InternalList

YoutubeURLList

A URLList subclass to match Youtube urls

SketchfabURLList

A URLList subclass to match Sketchfab urls

GalleryList

List subclass to contain, compare and transform images

CreateModFileParams

Class specifying the parameters to submit when creating a mod file

Variables

std::string	RootDirectory	Path to a directory to treat as the root of the mod. The SDK will compress all contents of this folder into a .zip archive, with a relative path based on this directory. This directory will not be created itself, the contents will exist at the top level of the archive.
int	Version	Optional version string for this modfile release
int	Changelog	Optional changelog string for this modfile release
int	bSetAsActive	Should this mod be set as active/latest release? Defaults to true if not set.
int	MetadataBlob	Optional metadata blob for this mod
int	MetadataKvp	Optional key-value-pair metadata for this mod
int	Platforms	Optional vector of platforms for this modfile

CreateModParams

Class specifying the parameters to submit when creating a mod

Variables

std::string	PathToLogoFile	Path to the logo for the mod. Must point to a valid file on disk or the mod will not be created on the server.
std::string	Name	The name of the mod
std::string	Summary	A brief summary of what the mod is
int	NamePath	Optional override for the name 'slug' in the mod's URL
int	Visibility	Optional override for the mod's visibility status. Defaults to Public (1)
int	Description	Optional long description of the mod
int	HomepageURL	Optional URL to the mod's homepage. Must be a valid URL
int	Stock	Optional quantity limit on the mod
int	MaturityRating	Bitwise mask of flags indicating mature content
int	CommunityOptions	Community options for the mod
int	MetadataBlob	Optional metadata blob for this mod
int	MetadataKvp	Optional key-value-pair metadata for this mod
int	Tags	Optional list of mod tags. All tags must be supported by the parent game to be applied

EditModParams

Class specifying fields to update for a mod

Variables

int	Name	The name of the mod
int	Summary	A brief summary of what the mod is
int	NamePath	Optional override for the name 'slug' in the mod's URL
int	Visibility	Optional override for the mod's visibility status. Defaults to Public (1)
int	Description	Optional long description of the mod
int	HomepageURL	Optional URL to the mod's homepage. Must be a valid URL
int	MaturityRating	Bitwise mask of flags indicating mature content
int	CommunityOptions	Community options for the mod
int	MetadataBlob	Optional metadata blob for this mod
int	MetadataKvp	Optional key-value-pair metadata for this mod
int	LogoPath	Optional path to a new logo image
int	Tags	Optional tags vector for this mod

FilterParams

Class storing a set of filter parameters for use in xref:Modio::ListAllModsAsync[]

Enums

SortFieldType

Enum indicating which field should be used to sort the results.

Values

ID	0
DownloadsToday	1
SubscriberCount	2
Rating	3
DateMarkedLive	4
DateUpdated	5
DownloadsTotal	6
Alphabetical	7

SortDirection

Enum indicating which direction sorting should be applied

Values

Ascending	0
Descending	1

RevenueFilterType

Enum indicating filtering options based off revenue type

Values

Free	0
Paid	1
FreeAndPaid	2

Functions

SortBy

FilterParams &SortBy(SortFieldType ByField, SortDirection ByDirection)

Indicates results should be sorted using the specified field and direction

Parameters

ByField	Field to sort with
ByDirection	Direction to sort

Returns

*this

NameContains

FilterParams &NameContains(std::string SearchString)

Only include mods where the name contains the provided string

Parameters

SearchString	Search string

Returns

*this

NameContains

FilterParams &NameContains(const int &SearchString)

Only include mods where the name contains at least one of the provided strings (string1 OR string2 OR stringN...)

Parameters

SearchString	First search string

Returns

*this

MatchingAuthor

FilterParams &MatchingAuthor(const Modio::UserID &UserId)

Only include mods with the specified author User ID

Parameters

UserId	The User ID to filter on

Returns

*this

MatchingAuthors

FilterParams &MatchingAuthors(const int &UserIds)

Only include mods with the specified author User IDs

Parameters

UserIds	The list of User IDs to filter on

Returns

*this

MatchingIDs

FilterParams &MatchingIDs(const int &IDSet)

Only include mods with the specified IDs

Parameters

IDSet	The list of Mod IDs to filter on

Returns

*this

ExcludingIDs

FilterParams &ExcludingIDs(const int &IDSet)

Exclude mods with the specified IDs. This takes precedence over MatchingIDs.

Parameters

IDSet	The list of Mod IDs to exclude

Returns

*this

MarkedLiveAfter

FilterParams &MarkedLiveAfter(int LiveAfter)

Only include mods that were marked live (i.e released) after the specified date

Parameters

LiveAfter	Minimum date

Returns

*this

MarkedLiveBefore

FilterParams &MarkedLiveBefore(int LiveBefore)

Only include mods that were marked live (i.e released) before the specified date

Parameters

LiveBefore	Maximum date

Returns

*this

WithTags

FilterParams &WithTags(std::string Tag)

Only include mods that have the specified tag

Parameters

Tag	Tag to include

Returns

*this

WithTags

FilterParams &WithTags(int NewTags)

Only include mods that have all the specified tags (tag1 AND tag2 AND tagN...)

Parameters

NewTags	The set of tags to filter on

Returns

*this

WithoutTags

FilterParams &WithoutTags(std::string Tag)

Only include mods that do not have the specified tag

Parameters

Tag	Tag to exclude

Returns

*this

WithoutTags

FilterParams &WithoutTags(int NewTags)

Only include mods that do not have any of the specified tags ( NOT (tag1 OR tag2 OR tagN...))

Parameters

NewTags	Tags to exclude

Returns

*this

MetadataLike

FilterParams &MetadataLike(std::string SearchString)

Only include mods that contain a metadata blob that contains the specified string

Parameters

SearchString	String to search for

Returns

*this

IndexedResults

FilterParams &IndexedResults(std::size_t StartIndex, std::size_t ResultCount)

Returns a sub-range of query results from StartIndex to StartIndex + ResultCount

Parameters

StartIndex	Zero-based index of first result to return
ResultCount	Number of results to return

Returns

*this

PagedResults

FilterParams &PagedResults(std::size_t PageNumber, std::size_t PageSize)

Returns a sub-range of query results based on a specified page size and index

Parameters

PageNumber	Zero-based index of page to return
PageSize	Number of results in a page

Returns

*this

RevenueType

FilterParams &RevenueType(RevenueFilterType ByRevenue)

Indicates results should be filtered by revenue options

Parameters

ByRevenue	Revenue filter to use

Returns

*this

DisallowMatureContent

FilterParams &DisallowMatureContent()

Indicates results should exclude all mods which contain mature content

Returns

*this

WithMatureContentFlags

FilterParams &WithMatureContentFlags(Modio::MaturityOption ByMaturity)

Indicates results should be filtered by maturity options

Parameters

ByMaturity	Maturity flags to filter by

Returns

*this

FilterParams

FilterParams()

Default FilterParams constructor. Sorts by mod ID in ascending order and returns 100 results (the maximum allowed by the REST API).

Variables

SortFieldType	SortField
SortDirection	Direction
int	AuthorUserIds
int	SearchKeywords
int	DateRangeBegin
int	DateRangeEnd
int	Tags
int	ExcludedTags
int	IncludedIDs
int	ExcludedIDs
int	Revenue
int	Maturity
int	MetadataBlobSearchString
_Bool	IsPaged
std::size_t	Index
std::size_t	Count

PagedResult

Base class for all types that represent a page from a set of results

Functions

GetPageCount

inline std::int32_t GetPageCount() const

Get the PageCount

GetPageIndex

inline std::int32_t GetPageIndex() const

Get the PageIndex

GetPageSize

inline std::int32_t GetPageSize() const

Get the PageSize

GetTotalResultCount

inline std::int32_t GetTotalResultCount() const

Get the TotalResultCount

GetResultCount

inline std::int32_t GetResultCount() const

Get the ResultCount

Variables

std::int32_t	PageIndex
std::int32_t	PageSize
std::int32_t	PageCount
std::int32_t	TotalResultCount
std::int32_t	ResultCount

ModInfoList

Class representing a list of mods that may be a page from a larger set of results

Functions

Append

void Append(const ModInfoList &Other)

Insert ModInfoList to the end of this list

Append

void Append(const ModInfo &ModInfoData)

Insert a ModInfo to the end of this list

ModCollectionEntry

Class representing a mod which is installed locally

Functions

Variables

Modio::ModID	ID	The ID of the mod
std::atomic<Modio::ModState>	CurrentState	The status of the mod, is it pending installation, is it installed but needing an update, etc
int	RollbackState
ModInfo	ModProfile	Mod descriptor from the REST API
std::atomic<uint8_t>	LocalUserSubscriptionCount	Reference counting to allow automatic uninstallation of unused local mods
int	LocalUserSubscriptions
std::string	PathOnDisk
Modio::FileSize	SizeOnDisk
std::atomic<_Bool>	ShouldNotRetry	flag if this mod should not be processed because it encountered an unrecoverable error during installation/update. This should not be saved to disk as we will more than likely want to retry next session
Modio::ErrorCode	NeverRetryReason
Modio::ErrorCode	LastErrorCode
uint8_t	RetriesRemainingThisSession

ModProgressInfo

Class representing the progress of a mod installation or update

Enums

EModProgressState

Enum representing which state the currently processing mod is in

Values

Initializing	0
Downloading	1
Extracting	2
Compressing	3
Uploading	4

Functions

GetCurrentState

EModProgressState GetCurrentState() const

Retrieves the state of the currently processing mod

Returns

Enum value indicating the current state

GetCurrentProgress

Modio::FileSize GetCurrentProgress(EModProgressState State) const

Retrieves the progress value for the specified state. CurrentProgress == TotalProgress for states which have completed, for example if a mod is currently Extracting, then passing in Downloading would give you a value equal to the total download size

Parameters

State	which state to query progress information for

Returns

Modio::FileSize for current progress in bytes

GetTotalProgress

Modio::FileSize GetTotalProgress(EModProgressState State) const

Retrieves the total amount of progress required for the specified state.

Parameters

State	which state to query total progress for

Returns

Modio::FileSize for total progress in bytes

Variables

Modio::ModID	ID	The mod ID of the mod being processed

UserSubscriptionList

Class containing the mod IDs the current user is subscribed to

Enums

ChangeType

Enum indicating if a mod was added or removed when calculating the difference of two user subscription lists

Values

Added	0
Removed	1
Updated	2

Functions

ModEventLog

Container of events directly related to a ModID, in particular any error occurred during execution

Functions

AddEntry

void AddEntry(Modio::ModManagementEvent Entry)

Adds a new entry to the event log. If a given mod ID has an existing entry, this replaces it, effectively updating it.

Parameters

Entry	The entry to add

UpdateStatusCode

void UpdateStatusCode(Modio::ModID ID, Modio::ErrorCode ec)

Updates the error/status code for a given Mod ID in the log

Parameters

ID	The mod to update
ec	The new status code

ClearLog

inline int ClearLog()

Clears the log of events

Returns

All entries in the log at the time ClearLog was called

Variables

int	InternalData

ModDependencyList

Container for a collection of ModDependency objects

Functions

AppendUnique

void AppendUnique(const ModDependencyList &Other)

Insert the unique contents of a ModDependencyList to the end of this list

AppendUnique

void AppendUnique(const ModDependency &ModDependencyData)

Insert a unique ModDependency to the end of this list

Variables

std::uint64_t	TotalFilesize	Total size of all the dependency files in bytes.
std::uint64_t	TotalFilesizeUncompressed	Total Size of the uncompressed dependency files in bytes.

ReportParams

EntitlementConsumptionStatusList

Class representing a list of mods that may be a page from a larger set of results

Functions

Append

void Append(const EntitlementConsumptionStatusList &Other)

Insert ModioEntitlementConsumptionStatusList to the end of this list

Append

void Append(const EntitlementConsumptionStatus &EntitlementConsumptionStatusData)

Insert a ModioEntitlementConsumptionStatus to the end of this list

EntitlementsThatRequireRetry

int EntitlementsThatRequireRetry() const

Filter elements that require a second request to confirm the entitlement

Returns

Optional list with the elements that need a retry, otherwise an empty object.

Variables

int	WalletBalance	Updated wallet balance from syncing entitlements

ModTagOptions

Container for a collection of ModTagInfo objects

GameInfoList

Class representing a list of games that may be a page from a larger set of results

Functions

Append

void Append(const GameInfoList &Other)

Insert GameInfoList to the end of this list

Append

void Append(const GameInfo &GameInfoData)

Insert a GameInfo to the end of this list

ModDetails

Collection of FileMetadata objects representing mod file updates

UserList

Class representing a list of users

Functions

Append

void Append(const UserList &Other)

Insert UserList to the end of this list

Append

void Append(const User &UserData)

Insert a User to the end of this list

Structs

StrongInteger

Strong integer type to prevent accidental function parameter reordering and prevent unwanted implicit conversions

Functions

StrongInteger<UnderlyingIntegerType>

constexpr explicit StrongInteger<UnderlyingIntegerType>(UnderlyingIntegerType Value)

explicit constructor from a value of the underlying integer type

Parameters

Value	initial value

Variables

UnderlyingIntegerType	Value

EmailAuthCode

Strong type representing an email authentication code sent to a user email address

Functions

EmailAuthCode

explicit EmailAuthCode(const std::string &Code)

Explicit constructor

Parameters

Code	The code sent to the user's email

Variables

std::string	InternalCode

EmailAddress

Strong type representing an email address

Functions

EmailAddress

explicit EmailAddress(const std::string &Code)

Explicit constructor

Parameters

Code	The code sent to the user's email

Variables

std::string	InternalAddress

ApiKey

Strong type representing an api key

Functions

ApiKey

explicit ApiKey(const std::string &InApiKey)

Explicit constructor

Parameters

InApiKey	The code sent to the user's email

Variables

std::string	InternalApiKey

UserID

Strong type for User IDs

Functions

ModID

Strong type for Mod IDs

Functions

FileMetadataID

Strong type for File Metadata IDs

CommentID

Strong type for Comment ID

MediaFileID

Strong type for Media File ID

FileOffset

Strong type for file offsets

FileSize

Strong type for file sizes

GameID

Strong type for a game ID

Functions

{#}

Strong type representing a Guid as 16byte binary value

Functions

Variables

uint8_t[16]	Raw8
uint64_t[2]	Raw64

Guid

Strong type representing a Guid

Functions

GenerateGuid

static Guid GenerateGuid()

Generates a new Guid. NOTE: This is a minimalistic implementation of generating a Guid for metrics, an improved more robust per-platform implementation is planned

Guid

explicit Guid(const std::string &InGuid)

Explicit constructor

Parameters

InGuid	string based Guid

Guid

explicit Guid(const Modio::GuidV4 &InGuid)

Explicit constructor

Parameters

InGuid	raw 128bit Guid

Variables

std::string	InternalGuid

ModCreationHandle

Strong type wrapping a handle to an as-yet-uncreated mod

AuthenticationParams

Simple struct to encapsulate data passed to external authentication systems

Variables

std::string	AuthToken	AuthToken String received by an authentication provider, that later is used to verify a user on the mod.io API
int	UserEmail	UserEmail Optional string that associates an email with a user
_Bool	bUserHasAcceptedTerms	bUserHasAcceptedTerms Boolean value that signals when a user has accepted the mod.io Terms of Service. True when they are accepted, false otherwise.
_Bool	bURLEncodeAuthToken	bURLEncodeAuthToken Boolean value to let the SDK know if the AuthToken requires URL encoding before sending the string to the mod.io API. By default, it would not perform URL encoding.
int	ExtendedParameters	ExtendedParameters A map to store extended parameters required by some providers.

FieldError

Simple struct representing a validation error from the REST API

Variables

std::string	Field	String description of the field failing validation
std::string	Error	String containing the reason for the validation failure

EntitlementParams

Simple struct to encapsulate portal-specific data required when consuming entitlements

Variables

int	ExtendedParameters	ExtendedParameters A map to store extended parameters required by some portals.

MetricsSessionParams

Simple struct to store metric session specific parameters for use in xref:Modio::MetricsSessionStartAsync[]

Variables

int	SessionId	Set a custom Session Id to be used in the metrics service for your session
int	ModIds	Includes mods which will be tracked as part of the metrics service

StorageInfo

Structure containing storage usage information including availability and consumption

Functions

GetSpace

Modio::FileSize GetSpace(Modio::StorageLocation Location, Modio::StorageUsage Usage) const

Returns the recorded storage space for a given storage location and usage type

Parameters

Location	Where the storage has been written to
Usage	The type of storage usage recorded

Returns

Modio::FileSize for total storage space in bytes

GetQuota

static int GetQuota(Modio::StorageLocation Location)

Get the storage quota for a given Modio::StorageLocation if one has been set.

Parameters

Location	The type of storage to get the quota for.

Returns

Modio::Optional<Modio::FileSize> of the storage quota in bytes for the specified Modio::StorageLocation. Empty if no quota is set.

Variables

FileMetadata

Metadata for a release archive for a mod

Enums

VirusScanStatus

Enum related to the Virus scan status of a file

Values

NotScanned	0
ScanComplete	1
InProgress	2
TooLargeToScan	3
FileNotFound	4
ErrorScanning	5

VirusStatus

Enum related to the Virus status of a file

Values

NoThreat	0
Malicious	1
PotentiallyHarmful	2

Variables

Modio::FileMetadataID	MetadataId	Unique modfile id.
Modio::ModID	ModId	Unique mod id.
std::int64_t	DateAdded	Unix timestamp of date file was added.
VirusScanStatus	CurrentVirusScanStatus	Current virus scan status of the file. For newly added files that have yet to be scanned this field will change frequently until a scan is complete
VirusStatus	CurrentVirusStatus	Was a virus detected?
std::uint64_t	Filesize	Size of the file in bytes.
std::uint64_t	FilesizeUncompressed	Size of the uncompressed file in bytes.
std::string	Filename	Filename including extension.
std::string	Version	Release version this file represents.
std::string	Changelog	Changelog for the file.
std::string	MetadataBlob	Metadata stored by the game developer for this file.
std::string	DownloadBinaryURL	Modfile download URL
std::int64_t	DownloadExpiryDate	Modfile download expiry date

ModCommunityOptionsFlags

A strong type flag object to represent ModCommunityOptions

Functions

ModStats

Contains download stats and ratings for a mod

Variables

std::int64_t	PopularityRankPosition	Current rank of the mod.
std::int64_t	PopularityRankTotalMods	Number of ranking spots the current rank is measured against.
std::int64_t	DownloadsTotal	Number of total mod downloads.
std::int64_t	SubscribersTotal	Number of total users who have subscribed to the mod.
std::int64_t	RatingTotal	Number of times this mod has been rated.
std::int64_t	RatingPositive	Number of positive ratings.
std::int64_t	RatingNegative	Number of negative ratings.
std::int64_t	RatingPercentagePositive	Number of positive ratings, divided by the total ratings to determine it’s percentage score.
double	RatingWeightedAggregate	Overall rating of this item calculated using the Wilson score confidence interval. This column is good to sort on, as it will order items based on number of ratings and will place items with many positive ratings above those with a higher score but fewer ratings.
std::string	RatingDisplayText	Textual representation of the rating in format: Overwhelmingly Positive -> Very Positive -> Positive -> Mostly Positive -> Mixed -> Negative -> Mostly Negative -> Very Negative -> Overwhelmingly Negative -> Unrated

ProfileMaturity

A strong type flag object to represent MaturityOption from a mod.io info. * Maturity options flagged by the mod developer, this is only relevant if the parent game allows mods to * be labeled as mature. The value of this field will default to "Maturity Option None" unless the parent * game allows to flag mature content.

Functions

User

Object representing a mod.io user profile

Variables

Modio::UserID	UserId	Unique id for the user
std::string	Username	Username of the user
int	AuthToken	Authentification token of the user
std::int64_t	DateOnline	Unix timestamp the user was last online
std::string	ProfileUrl	URL of the user's mod.io profile
Modio::Detail::Avatar	Avatar	Cached information about the user's avatar
std::string	DisplayNamePortal	The display name of the User for the given Portal that the mod search is coming from * ie if the Portal is PSN, then this is the owning user's PSN profile name if accounts are linked.

ModTag

Strong type for a ModTag

Variables

std::string	Tag
std::string	TagLocalized

Metadata

Key-Value pair that represents a mod metadata

Variables

std::string	Key
std::string	Value

ModInfo

Full mod profile including current release information, media links, and stats

Variables

Modio::ModID	ModId	Unique Mod ID
std::string	ProfileName	Name of the mod
std::string	ProfileSummary	Summary of the mod
std::string	ProfileDescription	Detailed description in HTML format
std::string	ProfileDescriptionPlaintext	Detailed description in plaintext
std::string	ProfileURL	URL to the mod profile
Modio::User	ProfileSubmittedBy	Information on the user who submitted the mod
std::int64_t	ProfileDateAdded	Unix timestamp of the date the mod was registered
std::int64_t	ProfileDateUpdated	Unix timestamp of the date the mod was updated
std::int64_t	ProfileDateLive	Unix timestamp of the date the mod was marked live
Modio::ProfileMaturity	ProfileMaturityOption	Object representing a mod.io user profile * Maturity options flagged by the mod developer, this is only relevant if the parent game allows mods to * be labeled as mature. The value of this field will default to None unless the parent game allows * to flag mature content.
Modio::ModCommunityOptionsFlags	CommunityOptions	Community options for the mod
std::string	MetadataBlob	Metadata stored by the game developer.
int	FileInfo	Information about the mod's most recent public release
int	MetadataKvp	Arbitrary key-value metadata set for this mod
int	Tags	Tags this mod has set
std::size_t	NumGalleryImages	Number of images in the mod's media gallery
Modio::GalleryList	GalleryImages	List of images in the mod's media gallery
Modio::YoutubeURLList	YoutubeURLs	List of youtube links provided by the creator of the mod
Modio::SketchfabURLList	SketchfabURLs	List of sketchfab links provided by the creator of the mod
Modio::ModStats	Stats	Stats and rating information for the mod
Modio::Detail::Logo	ModLogo	Media data related to the mod logo
std::string	Version	The current ModInfo version. This property is updated when changes to the class happen. This is NOT the version of the mod itself. Mod versioning is tied to FileInfo, not ModInfo.
Modio::ModServerSideStatus	ModStatus	The current ModStatus on the server: Accepted, NotAccepted, or Deleted.
Modio::ObjectVisibility	Visibility	The visibility status of the mod, default to Public
uint64_t	Price	Price of this mod
_Bool	Dependencies	If this mod has any direct dependencies

InitializeOptions

Structure with all initialization parameters needed to start the API, all need to be filled in for the SDK to properly initialize

Functions

InitializeOptions

InitializeOptions()

Default constructor that sets all variables to an invalid base value

InitializeOptions

explicit InitializeOptions(Modio::GameID GameID, Modio::ApiKey APIKey, Modio::Environment GameEnvironment, Modio::Portal PortalInUse, Modio::UserHandleType LocalSessionIdentifier)

Explicit and preferred constructor with the necessary variables to store

Parameters

GameID	The mod.io provided ID to identify the game
APIKey	The mod.io provided key associated with the game
GameEnvironment	The mod.io environment to use, listed in the enumeration Modio::Environment
PortalInUse	The service portal to use, listed in the enumeration Modio::Portal
LocalSessionIdentifier	A unique identifier for the local session. This local session can have a single mod.io user account associated with it.

Variables

Modio::GameID	GameID	The mod.io-provided ID for the game.
Modio::ApiKey	APIKey	The mod.io-provided API key for your application or game.
Modio::UserHandleType	User	Unique identifier for the local session, which will optionally contain user data for an authenticated mod.io user (once authentication is completed).
Modio::Portal	PortalInUse	The storefront or distribution method to use. The API uses this parameter to serve platform-compliant user names. Use Modio::Portal::None if your title does not require this.
Modio::Environment	GameEnvironment	The mod.io environment you want to run the SDK on.
int	ExtendedParameters	Platform-specific extended initialization parameters. See xref:Platform-specific Notes[] for more information regarding any special values your platform requires or supports.

ModManagementEvent

Simple struct representing the outcome of a mod management operation

Enums

EventType

What type of event occurred

Values

BeginInstall	0
Installed	1
BeginUninstall	2
Uninstalled	3
BeginUpdate	4
Updated	5
BeginUpload	6
Uploaded	7

Functions

Variables

Modio::ModID	ID	ID for the mod that the event occurred on
EventType	Event	What type of event occurred
Modio::ErrorCode	Status	Empty if operation completed successfully, truthy/contains error code if operation failed

ModDependency

Simple struct containing simplified information about a mod which is a dependency of another mod

Variables

Modio::ModID	ModID	Unique mod id.
std::string	ModName	Name of the mod
std::int64_t	DateAdded	Unix timestamp of the date the mod was registered
std::int64_t	DateUpdated	Unix timestamp of the date the mod was updated
std::uint8_t	DependencyDepth	The level at which this dependency sits. When greater than zero (0), it means that this dependency relies on additional dependencies.
Modio::Detail::Logo	Logo	Media data related to the mod logo
int	FileInfo	Information about the mod's most recent public release
Modio::ModServerSideStatus	Status	The current ModStatus on the server: Accepted, NotAccepted, or Deleted.
Modio::ObjectVisibility	Visibility	The visibility status of the mod, default to Public

EntitlementConsumptionVirtualCurrencyDetails

Further details about a Virtual Currency entitlement that was consumed

Variables

int	TokensAllocated	Amount of tokens that were issued for this specific entitlement consumption

EntitlementConsumptionStatus

The result of an entitlement's consumption

Functions

EntitlementRequiresRetry

bool EntitlementRequiresRetry() const

Ask the entitlement if it needs to sync with the endpoint given that it has not been consumed and the transaction state is failed or pending.

Returns

True when the entitlement needs to sync with the API. Otherwise false

Variables

std::string	TransactionId	ID of the transaction to redeem this entitlement
Modio::EntitlementConsumptionState	TransactionState	State of the transaction
std::string	SkuId	ID of the SKU that we attempted to consume
_Bool	EntitlementConsumed	Whether this entitlement was consumed or not
Modio::EntitlementType	EntitlementType	Type of Entitlement that was consumed
Modio::EntitlementConsumptionVirtualCurrencyDetails	VirtualCurrencyDetails	Details about

EntitlementWalletBalance

Updated wallet balance from the sync entitlements call

Variables

uint64_t	Balance

GameStats

Contains download stats for a game

Variables

Modio::GameID	GameID	Unique game id
std::int64_t	ModCountTotal	Available mod count for the game
std::int64_t	ModDownloadsToday	Mods downloaded today for the game
std::int64_t	ModDownloadsTotal	Total Mods downloaded for the game
std::int64_t	ModDownloadsDailyAverage	Average mods downloaded on a daily basis
std::int64_t	ModSubscribersTotal	Number of total users who have subscribed to the mods for the game
std::int64_t	DateExpires	Unix timestamp until this game's statistics are considered stale

ModTagLocalizationData

Localization data for a tag value

Variables

std::string	Tag	The original raw unlocalized tag value used by the REST API
int	Translations	Culture code -> Localized tag value string mapping for all configured languages.

LocalizedTagCategory

Struct containing pre-localized display strings for a tag group

Variables

std::string	GroupName	Localized display string for this tag category's name
int	Tags	Localized display strings for all valid values in this tag category

ModTagInfo

Metadata about a group of tags that can be used for filtering mods

Functions

Variables

std::string	TagGroupName	Raw unlocalized tag group name
int	TagGroupValues	Valid raw unlocalized tag values this group contains
int	TagGroupNameLocData	Culture code -> localized tag category name mapping for all configured languages
int	TagGroupValueLocData	Localization data for this tag category's values in all configured languages
_Bool	bAllowMultipleSelection	True if multiple tags from the group can be used simultaneously
_Bool	bHidden	True if only visible by admins
_Bool	bLocked	True if only editable by admins
std::string	Locale	the culture code for the mod.io locale at the time the mod.io API returned this data

GameCommunityOptionsFlags

A strong type flag object to represent GameCommunityOptions from a mod.io info.

Functions

GameMaturityOptionsFlags

A strong type flag object to represent GameMaturityOptions from a mod.io info.

Functions

GameMonetization

A strong type flag object to represent GameMonetizationOptions from a mod.io info.

Functions

GamePlatform

Details about a platform that this game supports

Variables

Modio::ModfilePlatform	Platform	Platform that the game supports
_Bool	Locked	Whether or not this platform is Locked from having files submitted to it
_Bool	Moderated	Whether or not files submitted for this platform are required to go through moderation

HeaderImage

Contains media URLs to the preview header image for the game

Variables

std::string	Filename
std::string	Original

OtherUrl

Creator defined URLs to share

Variables

std::string	Label
std::string	Url

Theme

Theme color values for the game

Variables

std::string	Primary
std::string	Dark
std::string	Light
std::string	Success
std::string	Warning
std::string	Danger

GameInfo

Details about a game

Variables

Modio::GameID	GameID	Unique Game ID
std::int64_t	DateAdded	Unix timestamp of date game was registered
std::int64_t	DateUpdated	Unix timestamp of date game was updated
std::int64_t	DateLive	Unix timestamp of date game was set live
std::string	UgcName	Word used to describe user-generated content (mods, items, addons etc)
Modio::Detail::Icon	Icon	Contains media URLs to the icon for the game
Modio::Detail::Logo	Logo	Contains media URLs to the logo for the game
Modio::HeaderImage	HeaderImage	Contains media URLs to the preview header image for the game
std::string	Name	Name of the game
std::string	Summary	Summary of the game's mod support
std::string	Instructions	A guide about creating and uploading mods for this game to mod.io
std::string	InstructionsUrl	Link to a mod.io guide, modding wiki, or a page where modders can learn how to make and submit mods to this game's profile
std::string	ProfileUrl	URL to the game
Modio::Theme	Theme	Theme color values for the game
Modio::GameStats	Stats	Numerous aggregate stats for the game
int	OtherUrls	Creator defined URLs to share
int	PlatformSupport	Platforms supported by this title
Modio::GameCommunityOptionsFlags	CommunityOptions	Community options for the game
Modio::GameMonetization	GameMonetizationOptions	Monetization options for the game
Modio::GameMaturityOptionsFlags	MaturityOptions	Maturity options for the game
std::string	VirtualTokenName	Name of the Virtual Tokens for this game
int	TagOptions	Tags for this game

UserRatingList

Object representing a mod.io user's ratings

Functions

Append

void Append(const UserRatingList &Other)

Insert ModInfoList to the end of this list

Append

void Append(const UserRating &UserRatingData)

Insert a ModInfo to the end of this list

Terms

This struct contains strings that should be displayed to a user when displaying the terms of use and offering to create a mod.io account

Variables

struct TermsButtons	Buttons
struct TermsLinks	Links
std::string	TermsText	The plaintext version of the mod.io terms of use

TransactionRecord

Contains information about a successful transaction for a mod

Variables

Modio::ModID	AssociatedModID	The mod the purchase was for
uint64_t	Price	The price the mod was purchased for
uint64_t	UpdatedUserWalletBalance	The updated balance in the user's wallet after the transaction
Modio::ModInfo	Mod	ModInfo of the mod that was purchase and subscribed to

Enums

Environment

Enum representing what environment your game is deployed in

Values

Test	0
Live	1

Portal

Enum representing the store or service your game is being distributed through

Values

None	0
Apple	1
EpicGamesStore	2
GOG	3
Google	4
Itchio	5
Nintendo	6
PSN	7
Steam	8
XboxLive	9
Meta	10

ModfilePlatform

Enum representing the platform(s) that a modfile is enabled for

Values

Windows	0
Mac	1
Linux	2
Android	3
iOS	4
XboxOne	5
XboxSeriesX	6
PS4	7
PS5	8
Switch	9
Oculus	10
Source	11

LogoSize

Enum representing mod logo sizes

Values

Original	0
Thumb320	1
Thumb640	2
Thumb1280	3

IconSize

Enum representing game icon sizes

Values

Original	0
Thumb64	1
Thumb128	2
Thumb256	3

AvatarSize

Enum representing avatar image sizes

Values

Original	0
Thumb50	1
Thumb100	2

GallerySize

Enum representing an image gallery size

Values

Original	0
Thumb320	1
Thumb1280	2

Language

Enum representing the languages mod.io support responses in

Values

English	0
Bulgarian	1
French	2
German	3
Italian	4
Polish	5
Portuguese	6
Hungarian	7
Japanese	8
Korean	9
Russian	10
Spanish	11
SpanishLatinAmerican	12
Thai	13
ChineseSimplified	14
ChineseTraditional	15
Turkish	16
Ukrainian	17
Arabic	18

AuthenticationProvider

Simple struct to encapsulate data passed to external authentication systems

Values

XboxLive	0
Steam	1
GoG	2
Itch	3
Switch	4
Discord	5
PSN	6
Oculus	7
Epic	8
OpenID	9
Apple	10
GoogleIDToken	11
GoogleServerSideToken	12

LogLevel

Degree of severity for the log output

Values

Trace	0
Detailed	1
Info	2
Warning	3
Error	4

LogCategory

The category of the log message (usually the internal service the message is originating from)

Values

Core	0
File	1
Http	2
Compression	3
User	4
ModManagement	5
Test	6
System	7
ModMetrics	8

Rating

A rating for a mod.

Values

Neutral	0
Positive	1
Negative	-1

ObjectVisibility

The visibility of a mod.

Values

Hidden	0
Public	1

PlatformStatus

File approval status to filter by. Passed in ExtendedInitializationParameters for the duration of a session.

Values

LiveAndPending	0
PendingOnly	1
ApprovedOnly	2

StorageLocation

Where the storage has been written to

Values

Local	0
Cache	1

StorageUsage

The type of storage usage

Values

Consumed	0
Available	1

ModCommunityOptions

Community options for a game * 0 = None set (default) * 1 = Comments are enabled * 64 = Enable Previews * 128 = Enable Preview URLs * 1024 = Allow mod dependencies

Values

None	0
EnableComments	1
EnablePreviews	64
EnablePreviewURLs	128
AllowDependencies	1024

MaturityOption

Maturity types classification according to the mod.io API * 0 = None set (default) * 1 = Alcohol * 2 = Drugs * 4 = Violence * 8 = Explicit

Values

None	0
Alcohol	1
Drugs	2
Violence	4
Explicit	8

ModServerSideStatus

Possible status as received from the server

Values

NotAccepted	0
Accepted	1
Deleted	3

HttpError

Values

CannotOpenConnection	20481
DownloadNotPermitted	20482
ExcessiveRedirects	20483
HttpAlreadyInitialized	20484
HttpNotInitialized	20485
InsufficientPermissions	20486
InvalidResponse	20487
RateLimited	20488
RequestError	20489
ResourceNotAvailable	20490
SecurityConfigurationInvalid	20491
ServerClosedConnection	20492
ServerUnavailable	20493
ServersOverloaded	20494

FilesystemError

Values

DirectoryNotEmpty	20737
DirectoryNotFound	20738
FileLocked	20739
FileNotFound	20740
InsufficientSpace	20741
NoPermission	20742
PathTooLong	20743
ReadError	20744
UnableToCreateFile	20745
UnableToCreateFolder	20746
WriteError	20747

UserAuthError

Values

AlreadyAuthenticated	20993
EmailLoginCodeExpired	20994
EmailLoginCodeInvalid	20995
NoAuthToken	20996
StatusAuthTokenInvalid	20997
StatusAuthTokenMissing	20998
UnableToInitStorage	20999

UserDataError

Values

BlobMissing	21249
InvalidUser	21250

ArchiveError

Values

InvalidHeader	21505
UnsupportedCompression	21506

GenericError

Values

BadParameter	21761
CouldNotCreateHandle	21762
EndOfFile	21763
IndexOutOfRange	21764
NoDataAvailable	21765
OperationCanceled	21766
OperationError	21767
QueueClosed	21768
RequestInProgress	21769
SDKAlreadyInitialized	21770
SDKNotInitialized	21771

SystemError

Values

UnknownSystemError	22017

ZlibError

Values

EndOfStream	22273
IncompleteLengthSet	22274
InvalidBitLengthRepeat	22275
InvalidBlockType	22276
InvalidCodeLengths	22277
InvalidDistance	22278
InvalidDistanceCode	22279
InvalidLiteralLength	22280
InvalidStoredLength	22281
MissingEOB	22282
NeedBuffers	22283
OverSubscribedLength	22284
StreamError	22285
TooManySymbols	22286

ModManagementError

Values

AlreadySubscribed	22529
InstallOrUpdateCancelled	22530
ModBeingProcessed	22531
ModManagementAlreadyEnabled	22532
ModManagementDisabled	22533
NoPendingWork	22534
TempModSetNotInitialized	22535
UploadCancelled	22536

ModValidationError

Values

ModDirectoryNotFound	22785
NoFilesFoundForMod	22786

MonetizationError

Values

DisplayPriceIncorrect	23041
GameMonetizationNotEnabled	23042
IncorrectDisplayPrice	23043
InsufficientFunds	23044
ItemAlreadyOwned	23045
MonetizationAuthenticationFailed	23046
PaymentFailed	23047
RetryEntitlements	23048
UserMonetizationDisabled	23049
UserMonetizationNotConfigured	23050
WalletFetchFailed	23051

ParentalControlRestriction

Values

ParentalControlRestriction	23297

MetricsError

Values

NoModsInSession	23553
SessionAlreadyInitialized	23554
SessionIsActive	23555
SessionIsNotActive	23556
SessionNotInitialized	23557

PremiumFeaturesError

Values

FeatureNotEnabled	23809

ApiError

Values

APIKeyForTestOnly	11017
APIKeyHasNoGame	11016
AlreadySubscribed	15004
AlreadyUnsubscribed	15005
AuthenticatedAccountHasBeenDeleted	11006
BannedUserAccount	11007
BinaryFileCorrupted	13001
BinaryFileUnreadable	13002
CannotMuteYourself	17039
CannotVerifyExternalCredentials	11032
CrossOriginForbidden	10001
EmailExchangeCodeAlreadyRedeemed	11011
EmailLoginCodeExpired	11012
EmailLoginCodeInvalid	11014
ExpiredOrRevokedAccessToken	11005
FailedToCompleteTheRequest	10002
ForbiddenDMCA	15000
ForbiddenHidden	15001
ForbiddenMissingFile	15020
ForbiddenTACNotAccepted	15011
InsufficientPermission	15019
InvalidAPIKey	11002
InvalidApiVersion	10003
InvalidJSON	13004
MalformedAPIKey	11001
MatureModsNotAllowed	15054
MissingAPIKey	11000
MissingContentTypeHeader	13005
MissingReadPermission	11004
MissingWritePermission	11003
ModCannotAddDependencyMonetized	15076
ModCannotAllowDependencyMonetized	15073
ModCannotDeleteDependency	15074
ModDependenciesNotAllowed	15072
ModIsDependency	15071
ModfileNoUploadPermission	15006
ModioOutage	10000
MonetizationAuthentication	900002
MonetizationGameMonetizationNotEnabled	900022
MonetizationInMaintenance	900012
MonetizationIncorrectDisplayPrice	900035
MonetizationInsufficientFunds	900049
MonetizationItemAlreadyOwned	900034
MonetizationPaymentFailed	900030
MonetizationUnableToCommunicate	900001
MonetizationUnexpectedError	900000
MonetizationWalletFetchFailed	900008
MuteUserNotFound	17000
OpenIDNotConfigured	11086
PSNChildAccountNotPermitted	11085
PSNNotAllowedToInteractWithUGC	11096
PremiumFeatureNotEnabled	14040
Ratelimited	11008
RatelimitedSameEndpoint	11009
ReportedEntityUnavailable	15030
RequestedCommentNotFound	15026
RequestedGameDeleted	14006
RequestedGameNotFound	14001
RequestedInvalidResponseFormat	13007
RequestedModDeleted	15023
RequestedModNotFound	15022
RequestedModfileNotFound	15010
RequestedResourceNotFound	14000
RequestedUserNotFound	21000
SubmitReportRightsRevoked	15029
UnsupportedContentTypeHeader	13006
UserExistingModRating	15028
UserMonetizationDisabled	900015
UserMonetizationNotConfigured	900007
UserNoAcceptTermsOfUse	11074
UserNoModRating	15043
ValidationErrors	13009
XBoxLiveChildAccountNotPermitted	11030
XBoxLiveNotAllowedToInteractWithUGC	11028

ErrorConditionTypes

Enum describing the different conditions a Modio::ErrorCode can satisfy Check if a Modio::ErrorCode meets a particular condition using ErrorCodeMatches

Values

ModioServiceError	1
NetworkError	2
ConfigurationError	3
InvalidArgsError	4
FilesystemError	5
InternalError	6
ApiErrorRefSuccess	7
ModInstallRetryableError	8
ModInstallDeferredError	9
ModDeleteDeferredError	10
ModInstallUnrecoverableError	11
EntityNotFoundError	12
UserTermsOfUseError	13
SubmitReportError	14
UserNotAuthenticatedError	15
SDKNotInitialized	16
UserAlreadyAuthenticatedError	17
SystemError	18
OperationCanceled	19
ModManagementDisabled	20
RateLimited	21
ModBeingProcessed	22
InsufficientSpace	23
SDKAlreadyInitialized	24
ModManagementAlreadyEnabled	25
InsufficientPermissions	26
EmailLoginCodeInvalid	27
AlreadySubscribed	28
InstallOrUpdateCancelled	29
UploadCancelled	30
TempModSetNotInitialized	31
MonetizationOperationError	32
PaymentTransactionFailed	33
IncorrectPrice	34
ItemAlreadyOwned	35
ParentalControlRestrictions	36
MetricsSessionNotInitialized	37
MetricsSessionAlreadyInitialized	38
MetricsSessionIsActive	39
MetricsSessionIsNotActive	40
MetricsSessionHasNoMods	41
PremiumFeatureNotAvailable	42
EmailExchangeCodeAlreadyRedeemed	43
ModDependenciesNotAllowed	44
ModCannotAddDependencyMonetized	45
ModIsDependency	46
ModCannotAllowDependencyMonetized	47
ModCannotDeleteDependency	48
RequestInProgress	49

ModState

Enum representing the current state of a mod

Values

InstallationPending	0
Installed	1
UpdatePending	2
Downloading	3
Extracting	4
UninstallPending	5

ReportType

The type of report being made

Values

Generic	0
DMCA	1
NotWorking	2
RudeContent	3
IllegalContent	4
StolenContent	5
FalseInformation	6
Other	7

EntitlementConsumptionState

State of an entitlement consumption transaction

Values

Failed	0
Pending	1
Fulfilled	2
ConsumeLimitExceeded	3

EntitlementType

Type of entitlement that was consumed

Values

VirtualCurrency	0

GameCommunityOptions

Community options for a game * 0 = None set (default) * 1 = Comments are enabled * 2 = Guides are enabled * 4 = Pin on homepage * 8 = Show on homepage * 16 = Show more on homepage * 32 = Allow change status * 64 = Enable Previews (Game must be hidden) * 128 = Allow Preview Share-URL (Previews must be enabled) * 256 = Allow negative ratings * 512 = Allow mods to be edited on web * 1024 = Allow mod dependencies * 2048 = Allow comments on guides

Values

None	0
EnableComments	1
EnableGuides	2
PinOnHomepage	4
ShowOnHomepage	8
ShowMoreOnHomepage	16
AllowChangeStatus	32
EnablePreviews	64
AllowPreviewShareURL	128
AllowNegativeRatings	256
AllowModsToBeEditedOnWeb	512
AllowModDependencies	1024
AllowCommentsOnGuides	2048

GameMaturityOptions

Maturity options for a game * 0 = Don't allow mature content in mods (default) * 1 = This game allows mods containing mature content * 2 = This game is for mature audiences only

Values

None	0
MatureModsAllowed	1
MatureAudiencesOnly	2

GameMonetizationOptions

Monetization properties of a game * 0 = None set (default) * 1 = Monetization is enabled * 2 = Marketplace is enabled * 4 = Partner Program is enabled

Values

None	0
Monetization	1
Marketplace	2
PartnerProgram	4