27 lines
1.1 KiB
C#
27 lines
1.1 KiB
C#
namespace Interfaces;
|
|
|
|
/// <summary>
|
|
/// Interface for entities that can be reported by users. This includes things like posts, comments, and user profiles.
|
|
/// The IReportUI interface will use this interface to determine what information to display when a user reports an
|
|
/// entity, and the IReportingHandler interface will use this interface to determine how to handle the report when it is
|
|
/// submitted.
|
|
/// </summary>
|
|
public interface IReportable
|
|
{
|
|
/// <summary>
|
|
/// Module Name is no longer required. Use ModuleID and EntityID instead to uniquely identify the type of entity being reported.
|
|
/// </summary>
|
|
[Obsolete]
|
|
public string ModuleName { get; }
|
|
|
|
/// <summary>
|
|
/// The ID of the Module from an Entity that is beeing reported.
|
|
/// This is used to determine the type of entity being reported.
|
|
/// </summary>
|
|
public int ModuleID { get; }
|
|
|
|
/// <summary>
|
|
/// The ID of an Entity that is beeing reported. This is used to determine the exact entity being reported.
|
|
/// </summary>
|
|
public int EntityID { get; }
|
|
} |