Skip to content

reports

Francisco Dias edited this page Dec 18, 2024 · 2 revisions

Reports

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_report

mod.io Endpoint: Submit Report


This function reports a resource on mod.io. You are responsible for content your users submit, so properly supporting the report endpoint or linking to the report page https://mod.io/report/widget is important. A successful request will return a Message struct.

Note

If you want to link to the mod.io report page and you know the resource you want to report, the best URL to use is https://mod.io/report/resource/id/widget. For example to report a mod with an ID of 1 the URL would be: https://mod.io/report/mods/1/widget. [!NOTE]

If you are a game owner or manager, you can view all reports submitted for your game. You can also configure in your games control panel the number of reports required before content is automatically taken down for review. [!NOTE]

Read the mod.io Terms of Use for information about what is/isn't acceptable.


Syntax:

modio_report(_resource, _unique_id, _type, _summary, _optionals, _callback_success, _callback_failed)
Argument Type Description
_resource String The type of resource you are reporting. Must be one of the following values: "games", "mods" and "users"
_unique_id Real Unique id of the resource you are reporting.
_type Real Type of report you are submitting. Must be one of the following values:

0 = Generic
1 = DMCA
2 = Not Working
3 = Rude Content
4 = Illegal Content
5 = Stolen Content
6 = False Information
7 = Other
_summary String Detailed description of your report. Make sure you include all relevant information and links to help moderators investigate and respond appropriately.
_optionals Struct - name (String) name of the user submitting the report. Recommended for DMCA reports.
- contact (String) Contact details of the user submitting the report. Recommended for DMCA reports.
_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:

Message



Clone this wiki locally