Appearance

Debology.Debby.Modules.Report ​

IDebbyReportAdapter Interface ​

An interface for Debby report adapters. This defines how to send a report and add attachments to it.

If you want to create a custom report adapter (e.g., you want to send reports to an internal service), you can implement this interface and pass it to Debby by calling SetCustomReportAdapter(IDebbyReportAdapter) in the Initialize(Action<DebbySettings>) callback.

csharp
public interface IDebbyReportAdapter

Properties ​

IDebbyReportAdapter.SupportsScreenshots Property ​

If the report adapter supports sending screenshots.

csharp
bool SupportsScreenshots { get; }

Property Value ​

System.Boolean

Methods ​

IDebbyReportAdapter.AddScreenshot(Texture2D) Method ​

Adds a screenshot to the report.

csharp
void AddScreenshot(Texture2D screenshot);

Parameters ​

screenshot UnityEngine.Texture2D

The screenshot to add.

IDebbyReportAdapter.Clear() Method ​

Clears any attachments / data from the report.

csharp
void Clear();

IDebbyReportAdapter.SendReport(string, string, Action<float>) Method ​

Sends a report with the given summary and description.

csharp
System.Threading.Tasks.Task<bool> SendReport(string summary, string description, System.Action<float> progress);

Parameters ​

summary System.String

The summary of the report.

description System.String

The detailed description of the report.

progress System.Action<System.Single>

An action to report the progress of the report sending.

Returns ​

System.Threading.Tasks.Task<System.Boolean>
A task representing the asynchronous operation.