Skip to content
This repository has been archived by the owner on Sep 21, 2022. It is now read-only.

Me (C compatible)

Ahmed Castro edited this page May 10, 2019 · 9 revisions

modioGetAuthenticatedUser

void modioGetAuthenticatedUser(void* object, void (*callback)(void* object, ModioResponse response, ModioUser user));

Wrapped by: Me#getauthenticateduser

API endpoint used: Get Authenticated User

Get the authenticated user details. Successful request will return a ModioUser Object.

Function parameters

Name Type Description
object void* Context parameter.
callback void (*callback)(void* object, ModioResponse response, ModioUser user) Function called once the process finished.

Callback parameters

Name Type Description
object void* Context parameter.
response ModioResponse ModioResponse object that contains the mod.io response status.
user ModioUser ModioUser object returned.

Example

void onGetAuthenticatedUser(void* object, ModioResponse response, ModioUser user)
{
  if(response.code == 200)
  {
    //User retrieved successfully
  }
}

[...]

modioGetAuthenticatedUser(NULL, &onGetAuthenticatedUser);

modioGetUserSubscriptions

void modioGetUserSubscriptions(void* object, ModioFilterCreator filter, void (*callback)(void* object, ModioResponse response, ModioMod mods[], u32 mods_size));

Wrapped by: Me#getusersubscriptions

API endpoint used: Get All Mods

Browse mods on mod.io, can be filtered using the ModioFilterCreator.

Function parameters

Name Type Description
object void* Context parameter.
filter ModioFilterCreator* ModioFilterCreator object to be customized.
callback void (*callback)(void* object, ModioResponse response, ModioMod mods[], u32 mods_size) Function called once the process finished.

Callback parameters

Name Type Description
object void* Context parameter.
response ModioResponse ModioResponse object that contains the mod.io response status.
mods ModioMod[] ModioMod array containing the returned mods.
mods_size u32 Mod array size.

Example

void onGetUserSubscriptions(void* object, ModioResponse response, ModioMod* mods, u32 mods_size)
{
  if(response.code == 200)
  {
    //User subscriptions retrieved successfully
  }
}

[...]

ModioFilterCreator filter;
modioInitFilter(&filter);
modioSetFilterLimit(&filter,3);

modioGetUserSubscriptions(NULL, filter, &onGetUserSubscriptions);

modioGetUserEvents

void modioGetUserEvents(void* object, ModioFilterCreator filter, void (*callback)(void* object, ModioResponse response, ModioModEvent* events_array, u32 events_array_size));

Wrapped by: Events#getuserevents

API endpoint used: Get User Events

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

Function parameters

Name Type Description
object void* Context paramter.
filter ModioFilterCreator* ModioFilterCreator object to be customized.
callback void (*callback)(void* object, ModioResponse response, ModioModEvent* mod_events_array, u32 mod_events_array_size) Function called once the process finished.

Callback parameters

Name Type Description
object void* Context paramter.
response ModioResponse ModioResponse object that contains the mod.io response status.
mod_events_array ModioModEvent* Array containing the ModioModEvent objects returned.
mod_events_array_size u32 Mod events array size.

Example

void onGetUserEvents(void* object, ModioResponse response, ModioModEvent* events_array, u32 events_array_size)
{
  if(response.code == 200)
  {
    //User events retrieved successfully
  }
}

[...]

ModioFilterCreator filter_creator;
modioInitFilter(&filter_creator);
modioSetFilterLimit(&filter_creator,3);

modioGetUserEvents(NULL, filter, &onGetAllModEvents);

modioGetUserGames

void modioGetUserGames(void* object, ModioFilterCreator filter, void (*callback)(void* object, ModioResponse response, ModioGame games[], u32 games_size));

Wrapped by: Me#getusergames

API endpoint used: Get User Games

Browse mods on mod.io, can be filtered using the ModioFilterCreator.

Function parameters

Name Type Description
object void* Context parameter.
filter ModioFilterCreator* ModioFilterCreator object to be customized.
callback void (*callback)(void* object, ModioResponse response, ModioGame games[], u32 games_size) Function called once the process finished.

Callback parameters

Name Type Description
object void* Context parameter.
response ModioResponse ModioResponse object that contains the mod.io response status.
games ModioGame[] ModioGame array.
games_size u32 Games array size.

Example

void onGetUserGames(void* object, ModioResponse response, ModioGame* games, u32 games_size)
{
  if(response.code == 200)
  {
    //User games retrieved successfully
  }
}

[...]

ModioFilterCreator filter;
modioInitFilter(&filter);
modioSetFilterLimit(&filter,3);

modioGetUserGames(NULL, filter, &onGetUserGames);

modioGetUserMods

void modioGetUserMods(void* object, ModioFilterCreator filter, void (*callback)(void* object, ModioResponse response, ModioMod mods[], u32 mods_size));

Wrapped by: Me#getusermods

API endpoint used: Get User Mods

Get all mods the authenticated user added or is a team member of. Successful request will return an array of ModioMod Objects.

Function parameters

Name Type Description
object void* Context parameter.
filter ModioFilterCreator* ModioFilterCreator object to be customized.
callback void (*callback)(void* object, ModioResponse response, ModioMod mods[], u32 mods_size) Function called once the process finished.

Callback parameters

Name Type Description
object void* Context parameter.
response ModioResponse ModioResponse object that contains the mod.io response status.
mods ModioMod[] ModioMod array.
mods_size u32 Mods array size.

Example

void onGetUserMods(void* object, ModioResponse response, ModioMod* mods, u32 mods_size)
{
  if(response.code == 200)
  {
    //User mods retrieved successfully
  }
}

[...]

ModioFilterCreator filter;
modioInitFilter(&filter);
modioSetFilterLimit(&filter,3);

modioGetUserMods(NULL, filter, &onGetUserMods);

modioGetUserModfiles

void modioGetUserModfiles(void* object, ModioFilterCreator filter, void (*callback)(void* object, ModioResponse response, ModioModfile modfiles[], u32 modfiles_size));

Wrapped by: Me#getusermodfiles

API endpoint used: Get User Modfiles

Get all modfiles the authenticated user uploaded. Successful request will return an array of ModioModfile Objects.

Function parameters

Name Type Description
object void* Context parameter.
filter ModioFilterCreator* ModioFilterCreator object to be customized.
callback void (*callback)(void* object, ModioResponse response, ModioModfile modfiles[], u32 modfiles_size) Function called once the process finished.

Callback parameters

Name Type Description
object void* Context parameter.
response ModioResponse ModioResponse object that contains the mod.io response status.
modfiles ModioModfile[] ModioModfile array.
modfiles_size u32 Modfile array size.

Example

void onGetUserModfiles(void* object, ModioResponse response, ModioModfile* modfiles, u32 modfiles_size)
{
  if(response.code == 200)
  {
    //User modfiles retrieved successfully
  }
}

[...]

ModioFilterCreator filter;
modioInitFilter(&filter);
modioSetFilterLimit(&filter,3);

modioGetUserModfiles(NULL, filter, &onGetUserModfiles);

modioGetUserRatings

void modioGetUserRatings(void* object, ModioFilterCreator filter, void (*callback)(void* object, ModioResponse response, ModioRating ratings[], u32 ratings_size));

Wrapped by: Me#getuserratings

API endpoint used: Get User Ratings

Get all mod rating's submitted by the authenticated user. Successful request will return an array of ModioRating Objects.

Function parameters

Name Type Description
object void* Context parameter.
filter ModioFilterCreator* ModioFilterCreator object to be customized.
callback void (*callback)(void* object, ModioResponse response, ModioRating ratings[], u32 ratings_size) Function called once the process finished.

Callback parameters

Name Type Description
object void* Context parameter.
response ModioResponse ModioResponse object that contains the mod.io response status.
ratings ModioRating[] ModioRating array.
ratings_size u32 Rating array size.

Example

void onGetUserRatings(void* object, ModioResponse response, ModioRating* rating, u32 ratings_size)
{
  if(response.code == 200)
  {
    //User ratings retrieved successfully
  }
}

[...]

ModioFilterCreator filter;
modioInitFilter(&filter);
modioSetFilterLimit(&filter,3);

modioGetUserRatings(NULL, filter, &onGetUserRatings);

Contents

Clone this wiki locally