Moderation SDK#

Report a player#

Once the setup is complete, you can report players by using their UAS ID and providing a reason for the report.

Once the player is reported, you can navigate to the Unity Dashboard to review incidents with the attached report information.

If you’re using the Vivox v16.0.0 package or higher, the last 15 minutes of the conversation from the channel that the reporter and the reported were in will be attached to the report.

Below is an example of a report being submitted:

using Unity.Services.Moderation;
using Unity.Services.Moderation.Models;
using Unity.Services.Moderation.Exceptions;

public async void Report(string userId)
{
    // userId should be the UAS id of the reported player
    // eg: the currently logged in user id is accessible with
    // var MyUserId = AuthenticationService.Instance.PlayerId

    try {
        var report = Moderation.Instance.NewReport(userId,
            new ReportReason(ReportReason.Threat));
        await Moderation.Instance.ReportPlayer(report);
        Debug.Log("Report submitted!");
    } catch (ModerationServiceException e){
        if (e.Reason == ModerationServiceExceptionReason.SelfReportError) {
            Debug.Log("Error: you can’t report yourself");
        } else {
            Debug.Log($"Error: {e.Reason}");
        }
    }
}

Report reason#

Reasons are defined by Unity and are available as an array to display in your game:

using Unity.Services.Moderation.Models;

public ListReasons()
{
  foreach (var reason in ReportReason.PossibleReasons)
  {
      Debug.Log(reason);
  }
}

The constants for each reason can be found in Moderation > Runtime > Models > ReportReasons.cs.

Actions#

Actions are applied through the Dashboard when reviewing incidents.

When an action is applied, and the actioned user logs in, you will receive various error messages from the different UGS packages integrated with the Moderation services. Errors will follow the access control convention described in Error responses. This is the expected behavior.

Some SDKs will provide a mechanism to wrap those errors into exceptions of their own, for example, the Vivox SDK will emit a MintException when a policy is preventing a user from accessing communications.

Below is the supported sanctions error list:

Evidence management#

If Vivox version 16.0.0 or higher is installed in the project, the SDK will automatically include the list of channels both the reporter and reported players are part of. As well as the list of extra players that were part of those channels.

This information is used to add details to the evidence in the report. The extra players' tracks will be included in the Safe Voice screenings and each channel included in the channel list will be screened.

To better control the report context, you can alter the list of channels and players included in the report before it's sent.

var report = Moderation.Instance.NewReport(userId, new ReportReason(ReportReason.Threat));

report.Players = new List<PlayerContext>(); // The list of extra players you want to include in Safe Voice screenings.
report.VivoxChannels = new List<VivoxChannel>(); // The list of channels to be screened by Safe Voice.