Skip to content

me

Jump to bottom
YYBartT edited this page Jun 16, 2023 · 2 revisions

Me

Functions

This module offers a collection of functions designed to address specific tasks and provide utilities for various purposes. Explore the available functions to make the most of the functionalities provided by this module.


Back To Top

modio_me

mod.io Endpoint: Get Authenticated User


This function gets the authenticated user details. A successful request will return a single User struct.


Syntax:

modio_me(_callback_success, _callback_failed)
Argument Type Description
_callback_success Function or Method The function to trigger when the request is successful.
_callback_failed Function or Method The function to trigger when the request failed.

Returns:

User



Back To Top

modio_me_events

mod.io Endpoint: Get User Events


This function gets events that have been fired specific to the user. A successful request will return an array of ModEvent. We recommended reading the filtering documentation to return only the records you want.


Syntax:

modio_me_events(_callback_success, _callback_failed)
Argument Type Description
_callback_success Function or Method The function to trigger when the request is successful.
_callback_failed Function or Method The function to trigger when the request failed.

Returns:

GetUserEvents



Back To Top

modio_me_files

mod.io Endpoint: Get User Modfiles


This function gets all modfiles the authenticated user uploaded. A successful request will return an array of Modfile structs. We recommended reading the filtering documentation to return only the records you want.

ℹ️ NOTE

If the game requires mod downloads to be initiated via the API, the binary_url returned will contain a verification hash. This hash must be supplied to get the modfile, and will expire after a certain period of time. Saving and reusing the binary_url won't work in this situation given its dynamic nature.


Syntax:

modio_me_files(_callback_success, _callback_failed)
Argument Type Description
_callback_success Function or Method The function to trigger when the request is successful.
_callback_failed Function or Method The function to trigger when the request failed.

Returns:

GetModfiles



Back To Top

modio_me_games

mod.io Endpoint: Get User Games


This function gets all games the authenticated user added or is a team member of. A successful request will return an array of Game structs. We recommend reading the filtering documentation to return only the records you want.


Syntax:

modio_me_games(_callback_success, _callback_failed)
Argument Type Description
_callback_success Function or Method The function to trigger when the request is successful.
_callback_failed Function or Method The function to trigger when the request failed.

Returns:

GetGames



Back To Top

modio_me_subscriptions

mod.io Endpoint: Get User Subscriptions


This function gets all mods the authenticated user is subscribed to. A successful request will return an array of Mod structs. We recommend reading the filtering documentation to return only the records you want.


Syntax:

modio_me_subscriptions(_callback_success, _callback_failed)
Argument Type Description
_callback_success Function or Method The function to trigger when the request is successful.
_callback_failed Function or Method The function to trigger when the request failed.

Returns:

GetMods



Back To Top

modio_me_mods

mod.io Endpoint: Get User Mods


This function gets all mods the authenticated user added or is a team member of. A successful request will return an array of Mod structs. We recommend reading the filtering documentation to return only the records you want.


Syntax:

modio_me_mods(_callback_success, _callback_failed)
Argument Type Description
_callback_success Function or Method The function to trigger when the request is successful.
_callback_failed Function or Method The function to trigger when the request failed.

Returns:

GetMods



Back To Top

modio_me_user_muted

mod.io Endpoint: Get Users Muted


This function gets all users muted by the authenticated user. A successful request will return an array of User structs.


Syntax:

modio_me_user_muted(_callback_success, _callback_failed)
Argument Type Description
_callback_success Function or Method The function to trigger when the request is successful.
_callback_failed Function or Method The function to trigger when the request failed.

Returns:

GetMutedUsers



Back To Top

modio_me_ratings

mod.io Endpoint: Get User Ratings


This function gets all mod ratings submitted by the authenticated user. A successful request will return an array of Rating structs.


Syntax:

modio_me_ratings(_callback_success, _callback_failed)
Argument Type Description
_callback_success Function or Method The function to trigger when the request is successful.
_callback_failed Function or Method The function to trigger when the request failed.

Returns:

GetUserRatings



GameMaker 2023

Clone this wiki locally