Modules

A module is a self-contained unit of types, actions, reports and channels. It allows you to organize your different tools.

INFO

An example for a module is the "Chat" module, which contains types for chat messages, rooms, users and media. Another example is the "Forum" module, which contains types for forum posts, comments, users and media. This is a logical grouping, even if both modules are used in the same application.

Creating a Module

INFO

Only administrators can create modules.

Modules are necessary to organize your types, actions, reports and channels. You cannot use UGC Guard without at least one module. To create a module, login as an administrator and navigate to the "Modules" section in the admin sidebar. Click on the "Create Module" button and fill in the required information, such as the module name and description.

Once you have filled in the information, click on the "Create" button to create the module.

Using a Module

Once you have created a module, you find its ID in the module list. Pressing the key button, displays you the modules secret key. You need both the ID and the secret key to use the module in your application for reporting content.

Switching Modules

If you have multiple modules, you can switch between them in the admin sidebar. This reloads the page and displays the content of the selected module.

Deleting a Module

DANGER

Deleting a module is a destructive action and cannot be undone. All types, actions, reports and channels associated with the module will be deleted.

To delete a module, navigate to the "Modules" section in the admin sidebar, find the module you want to delete, and click on the "Delete" button next to it. You will be asked to confirm the deletion. Once you confirm, the module and all its associated types, actions, reports and channels will be deleted permanently.