subscribe

Subscribe

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.

• modio_subscribe
• modio_unsubscribe

---

Back To Top

modio_subscribe

mod.io Endpoint: Subscribe To Mod

This function subscribes the authenticated user to a corresponding mod. A successful request will return the Mod struct of the newly subscribed mod.

Syntax:

modio_subscribe(_mod_id, _callback_success, _callback_failed, _game_id)

Argument	Type	Description
_mod_id	Real	Unique id of the mod.
_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.
_game_id	Real	OPTIONAL The ID of the game, defaults to the value set in the Game ID extension option if not provided

Returns:

Mod

---

Back To Top

modio_unsubscribe

mod.io Endpoint: Unsubscribe From Mod

This function unsubscribes the authenticated user from the corresponding mod.

Note

Users can unsubscribe from mods via mod.io, we recommend you poll modio_events_get when needed, to keep a user's mods collection up to date.

Syntax:

modio_unsubscribe(_mod_id, _callback_success, _callback_failed, _game_id)

Argument	Type	Description
_mod_id	Real	Unique id of the mod.
_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.
_game_id	Real	OPTIONAL The ID of the game, defaults to the value set in the Game ID extension option if not provided

Returns:

N/A