Skip to content

Types

Types are the core building blocks of UGC Guard. They define the structure of the content that can be reported and moderated. Each type represents a specific kind of content, such as a chat message, forum post, or a user profile.

Creating a Type

INFO

Only administrators can create types.

To create a type, log in as an administrator and navigate to the "Types & Actions" section in the admin sidebar.

Click on the "Create Type" button and fill in the required information, such as the type name, description. If this is the user type of your module, select the "User" checkbox.

About the User Type

Each module can have a specific user type. This type will be chosen if a reviewer tries to perform an action on creators of content in reports.

INFO

So if you want to enable reviewers to restrict users that created violating content, define the actions in the user type of the module.

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

Using a Type

Once you have created a type, you can use it in your application for reporting content. You will need the type ID that is displayed in the type list. This ID is used to identify the type when reporting content.

Action secrets

In the type list, you can also find the action secret of the type. This secret is a symmetric key that is used to sign actions that are performed on this type. See Actions for more information on how to use the action secret.

Deleting a Type

DANGER

Deleting a type is a destructive action and cannot be undone. All actions and content associated with the type will be deleted.

To delete a type, navigate to the "Types & Actions" section in the admin sidebar, find the type 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 type and all its associated actions and content will be deleted permanently.