Me - modio/modio-sdk-legacy GitHub Wiki

getAuthenticatedUser

void Instance::getAuthenticatedUser(const std::function<void(const modio::Response& response, const modio::User& user)>& callback);

API endpoint used: Get Authenticated User

Get the authenticated user details. Successful request will return a modio::User Object.

Function parameters

Name Type Description
callback const std::function<void(const modio::Response& response, const modio::User& user)>& Function called once the process finished.

Callback parameters

Name Type Description
response const modio::Response& modio::Response object that contains the mod.io response status.
mod const modio::User& user modio::User object.

Example

modio_instance.getAuthenticatedUser([&](const modio::Response& response, const modio::User& user)
{
  if(response.code == 200)
  {
    //Mod successfully retrieved
  }
});

getUserSubscriptions

void Instance::getUserSubscriptions(modio::FilterCreator& filter, const std::function<void(const modio::Response& response, const std::vector<modio::Mod> & mods)>& callback);

API endpoint used: Get User Subscriptions

Get all mod's the authenticated user is subscribed to.

Function parameters

Name Type Description
filter_creator modio::FilterCreator& modio::FilterCreator object to be customized.
callback const std::function<void(const modio::Response& response, const std::vector<modio::Mod>& mods)>& Function called once the process finished.

Callback parameters

Name Type Description
response const modio::Response& modio::Response object that contains the mod.io response status.
mods const std::vector<modio::Mod>& modio::Mod object vector.

Example

modio::FilterCreator filter_creator;
filter_creator.setFilterLimit(3);

modio_instance.getUserSubscriptions(filter, [&](const modio::Response& response, const std::vector<modio::Mod> & mods)
{
  if(response.code == 200)
  {
    //User subscriptions successfully retrieved
  }
});

getUserEvents

void getUserEvents(modio::FilterCreator& filter, const std::function<void(const modio::Response&, const std::vector<modio::ModEvent> & events)>& callback);

API endpoint used: Get User Events

Get events that have been fired specific to the user. The result can be filtered using the modio::FilterCreator.

Function parameters

Name Type Description
filter_creator modio::FilterCreator& modio::FilterCreator object to be customized.
callback const std::function<void(const modio::Response&, const std::vector<modio::ModEvent> & events)>& Function called once the process finished.

Callback parameters

Name Type Description
response const modio::Response& modio::Response object that contains the mod.io response status.
mod_events std::vector<modio::ModEvent> Vector containing the modio::ModEvent objects returned.

Example

modio_instance.getUserEvents(filter, [&](const modio::Response& response, const std::vector<modio::ModEvent> & events)
{
  if(response.code == 200)
  {
    //User events successfully retrieved
  }
});

getUserGames

void Instance::getUserGames(modio::FilterCreator& filter, const std::function<void(const modio::Response& response, const std::vector<modio::Game> & games)>& callback);

API endpoint used: Get User Games

Get all games the authenticated user added or is a team member of. Successful request will return a vector of modio::Game Objects.

Function parameters

Name Type Description
filter_creator modio::FilterCreator& modio::FilterCreator object to be customized.
callback const std::function<void(const modio::Response& response, const std::vector<modio::Game>& games)>& Function called once the process finished.

Callback parameters

Name Type Description
response const modio::Response& modio::Response object that contains the mod.io response status.
games const std::vector<modio::Game>& modio::Game object vector.

Example

modio::FilterCreator filter_creator;
filter_creator.setFilterLimit(3);

modio_instance.getUserGames(filter, [&](const modio::Response& response, const std::vector<modio::Game> & games)
{
  if(response.code == 200)
  {
    //User games successfully retrieved
  }
});

getUserMods

void Instance::getUserMods(modio::FilterCreator& filter, const std::function<void(const modio::Response& response, const std::vector<modio::Mod> & mods)>& callback);

API endpoint used: Get User Mods

Get all mods the authenticated user added or is a team member of. Successful request will return a vector of modio::Mod Objects.

Function parameters

Name Type Description
filter_creator modio::FilterCreator& modio::FilterCreator object to be customized.
callback const std::function<void(const modio::Response& response, const std::vector<modio::Mod>& mods)>& Function called once the process finished.

Callback parameters

Name Type Description
response const modio::Response& modio::Response object that contains the mod.io response status.
mods const std::vector<modio::Mod>& modio::Mod object vector.

Example

modio::FilterCreator filter_creator;
filter_creator.setFilterLimit(3);

modio_instance.getUserMods(filter, [&](const modio::Response& response, const std::vector<modio::Mod> & mods)
{
  if(response.code == 200)
  {
    //User mods successfully retrieved
  }
});

getUserModfiles

void Instance::getUserModfiles(modio::FilterCreator& filter, const std::function<void(const modio::Response& response, const std::vector<modio::Modfile> & modfiles)>& callback);

API endpoint used: Get User Modfiles

Get all modfiles the authenticated user uploaded. Successful request will return a vector of modio::Modfile Objects.

Function parameters

Name Type Description
filter_creator modio::FilterCreator& modio::FilterCreator object to be customized.
callback const std::function<void(const modio::Response& response, const std::vector<modio::Modfile>& modfiles)>& Function called once the process finished.

Callback parameters

Name Type Description
response const modio::Response& modio::Response object that contains the mod.io response status.
modfiles const std::vector<modio::Modfile>& modio::Modfile object vector.

Example

modio::FilterCreator filter_creator;
filter_creator.setFilterLimit(3);

modio_instance.getUserModfiles(filter, [&](const modio::Response& response, const std::vector<modio::Modfile> & modfiles)
{
  if(response.code == 200)
  {
    //User modfiles successfully retrieved
  }
});

getUserRatings

void Instance::getUserRatings(modio::FilterCreator& filter, const std::function<void(const modio::Response& response, const std::vector<modio::Rating> & ratings)>& callback);

API endpoint used: Get User Ratings

Get all mod rating's submitted by the authenticated user. Successful request will return a vector of modio::Rating Objects.

Function parameters

Name Type Description
filter_creator modio::FilterCreator& modio::FilterCreator object to be customized.
callback const std::function<void(const modio::Response& response, const std::vector<modio::Rating>& ratings)>& Function called once the process finished.

Callback parameters

Name Type Description
response const modio::Response& modio::Response object that contains the mod.io response status.
ratings const std::vector<modio::Rating>& modio::Rating object vector.

Example

modio::FilterCreator filter_creator;
filter_creator.setFilterLimit(3);

modio_instance.getUserRatings(filter, [&](const modio::Response& response, const std::vector<modio::Rating> & ratings)
{
  if(response.code == 200)
  {
    //User ratings successfully retrieved
  }
});
⚠️ **GitHub.com Fallback** ⚠️